Floatplane API

ACPCreator

checkCreatorURLAvailable

Check Creator Url Available

TODO


/api/acp/v2/creator/urlname/availability

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/urlname/availability"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.checkCreatorURLAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#checkCreatorURLAvailable");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.checkCreatorURLAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#checkCreatorURLAvailable");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Check Creator Url Available
[apiInstance checkCreatorURLAvailableWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkCreatorURLAvailable(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class checkCreatorURLAvailableExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Check Creator Url Available
                oas_any_type_not_mapped result = apiInstance.checkCreatorURLAvailable();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.checkCreatorURLAvailable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->checkCreatorURLAvailable();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->checkCreatorURLAvailable: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->checkCreatorURLAvailable();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->checkCreatorURLAvailable: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Check Creator Url Available
    api_response = api_instance.check_creator_url_available()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->checkCreatorURLAvailable: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.checkCreatorURLAvailable(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


createCreator

Create Creator

TODO


/api/acp/v2/creator/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#createCreator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#createCreator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Create Creator
[apiInstance createCreatorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCreator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createCreatorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Create Creator
                oas_any_type_not_mapped result = apiInstance.createCreator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.createCreator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->createCreator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->createCreator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->createCreator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->createCreator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Create Creator
    api_response = api_instance.create_creator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->createCreator: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.createCreator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


createCreatorInviteCode

Create Creator Invite Code

TODO


/api/acp/v3/creator/invite/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v3/creator/invite/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#createCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#createCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Create Creator Invite Code
[apiInstance createCreatorInviteCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCreatorInviteCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createCreatorInviteCodeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Create Creator Invite Code
                oas_any_type_not_mapped result = apiInstance.createCreatorInviteCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.createCreatorInviteCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->createCreatorInviteCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->createCreatorInviteCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->createCreatorInviteCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->createCreatorInviteCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Create Creator Invite Code
    api_response = api_instance.create_creator_invite_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->createCreatorInviteCode: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.createCreatorInviteCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreatorCategories

Get Creator Categories

TODO


/api/acp/v2/creator/category/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/category/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorCategories();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorCategories");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorCategories();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorCategories");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Get Creator Categories
[apiInstance getCreatorCategoriesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorCategories(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorCategoriesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Get Creator Categories
                oas_any_type_not_mapped result = apiInstance.getCreatorCategories();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.getCreatorCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->getCreatorCategories();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->getCreatorCategories: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->getCreatorCategories();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->getCreatorCategories: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Get Creator Categories
    api_response = api_instance.get_creator_categories()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->getCreatorCategories: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.getCreatorCategories(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreatorDetails

Get Creator Details

TODO


/api/acp/v2/creator/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorDetails");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Get Creator Details
[apiInstance getCreatorDetailsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorDetailsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Get Creator Details
                oas_any_type_not_mapped result = apiInstance.getCreatorDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.getCreatorDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->getCreatorDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->getCreatorDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->getCreatorDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->getCreatorDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Get Creator Details
    api_response = api_instance.get_creator_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->getCreatorDetails: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.getCreatorDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreatorInviteCodeList

Get Creator Invite Code List

TODO


/api/acp/v3/creator/invite/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v3/creator/invite/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorInviteCodeList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorInviteCodeList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Get Creator Invite Code List
[apiInstance getCreatorInviteCodeListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorInviteCodeList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorInviteCodeListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Get Creator Invite Code List
                oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.getCreatorInviteCodeList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->getCreatorInviteCodeList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->getCreatorInviteCodeList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->getCreatorInviteCodeList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->getCreatorInviteCodeList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Get Creator Invite Code List
    api_response = api_instance.get_creator_invite_code_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->getCreatorInviteCodeList: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.getCreatorInviteCodeList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreatorList

Get Creator List

TODO


/api/acp/v2/creator/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Get Creator List
[apiInstance getCreatorListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Get Creator List
                oas_any_type_not_mapped result = apiInstance.getCreatorList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.getCreatorList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->getCreatorList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->getCreatorList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->getCreatorList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->getCreatorList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Get Creator List
    api_response = api_instance.get_creator_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->getCreatorList: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.getCreatorList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreatorsTitles

Get Creators Titles

TODO


/api/acp/v2/creator/titles

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/titles"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorsTitles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorsTitles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorsTitles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getCreatorsTitles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Get Creators Titles
[apiInstance getCreatorsTitlesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorsTitles(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorsTitlesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Get Creators Titles
                oas_any_type_not_mapped result = apiInstance.getCreatorsTitles();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.getCreatorsTitles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->getCreatorsTitles();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->getCreatorsTitles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->getCreatorsTitles();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->getCreatorsTitles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Get Creators Titles
    api_response = api_instance.get_creators_titles()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->getCreatorsTitles: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.getCreatorsTitles(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getSubscriptionPlanList

Get Subscription Plan List

TODO


/api/acp/v2/creator/subscriptionplans/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/subscriptionplans/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getSubscriptionPlanList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getSubscriptionPlanList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getSubscriptionPlanList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#getSubscriptionPlanList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Get Subscription Plan List
[apiInstance getSubscriptionPlanListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSubscriptionPlanList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSubscriptionPlanListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Get Subscription Plan List
                oas_any_type_not_mapped result = apiInstance.getSubscriptionPlanList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.getSubscriptionPlanList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->getSubscriptionPlanList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->getSubscriptionPlanList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->getSubscriptionPlanList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->getSubscriptionPlanList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Get Subscription Plan List
    api_response = api_instance.get_subscription_plan_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->getSubscriptionPlanList: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.getSubscriptionPlanList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateCreator

Update Creator

TODO


/api/acp/v2/creator/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#updateCreator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#updateCreator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Update Creator
[apiInstance updateCreatorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCreator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateCreatorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Update Creator
                oas_any_type_not_mapped result = apiInstance.updateCreator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.updateCreator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->updateCreator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->updateCreator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->updateCreator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->updateCreator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Update Creator
    api_response = api_instance.update_creator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->updateCreator: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.updateCreator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateCreatorSubscriptionPlan

Update Creator Subscription Plan

TODO


/api/acp/v2/creator/subscriptionplan/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/subscriptionplan/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateCreatorSubscriptionPlan();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#updateCreatorSubscriptionPlan");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateCreatorSubscriptionPlan();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#updateCreatorSubscriptionPlan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Update Creator Subscription Plan
[apiInstance updateCreatorSubscriptionPlanWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCreatorSubscriptionPlan(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateCreatorSubscriptionPlanExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Update Creator Subscription Plan
                oas_any_type_not_mapped result = apiInstance.updateCreatorSubscriptionPlan();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.updateCreatorSubscriptionPlan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->updateCreatorSubscriptionPlan();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->updateCreatorSubscriptionPlan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->updateCreatorSubscriptionPlan();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->updateCreatorSubscriptionPlan: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Update Creator Subscription Plan
    api_response = api_instance.update_creator_subscription_plan()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->updateCreatorSubscriptionPlan: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.updateCreatorSubscriptionPlan(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


uploadCard

Upload Card

TODO


/api/acp/v2/creator/card/upload

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/card/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadCard();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#uploadCard");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadCard();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#uploadCard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Upload Card
[apiInstance uploadCardWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadCard(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadCardExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Upload Card
                oas_any_type_not_mapped result = apiInstance.uploadCard();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.uploadCard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->uploadCard();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->uploadCard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->uploadCard();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->uploadCard: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Upload Card
    api_response = api_instance.upload_card()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->uploadCard: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.uploadCard(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


uploadCover

Upload Cover

TODO


/api/acp/v2/creator/cover/upload

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/cover/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadCover();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#uploadCover");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadCover();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#uploadCover");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Upload Cover
[apiInstance uploadCoverWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadCover(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadCoverExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Upload Cover
                oas_any_type_not_mapped result = apiInstance.uploadCover();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.uploadCover: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->uploadCover();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->uploadCover: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->uploadCover();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->uploadCover: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Upload Cover
    api_response = api_instance.upload_cover()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->uploadCover: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.uploadCover(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


uploadIcon

Upload Icon

TODO


/api/acp/v2/creator/icon/upload

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creator/icon/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorApi;

import java.io.File;
import java.util.*;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadIcon();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#uploadIcon");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorApi;

public class ACPCreatorApiExample {
    public static void main(String[] args) {
        ACPCreatorApi apiInstance = new ACPCreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadIcon();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorApi#uploadIcon");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorApi *apiInstance = [[ACPCreatorApi alloc] init];

// Upload Icon
[apiInstance uploadIconWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadIcon(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadIconExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorApi();

            try {
                // Upload Icon
                oas_any_type_not_mapped result = apiInstance.uploadIcon();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorApi.uploadIcon: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorApi();

try {
    $result = $api_instance->uploadIcon();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorApi->uploadIcon: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorApi->new();

eval { 
    my $result = $api_instance->uploadIcon();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorApi->uploadIcon: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorApi()

try: 
    # Upload Icon
    api_response = api_instance.upload_icon()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorApi->uploadIcon: %s\n" % e)
extern crate ACPCreatorApi;

pub fn main() {

    let mut context = ACPCreatorApi::Context::default();
    let result = client.uploadIcon(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ACPCreatorAgreement

editCreatorAgreement

Edit Creator Agreement

TODO


/api/acp/v2/creatoragreement/edit

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creatoragreement/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorAgreementApi;

import java.io.File;
import java.util.*;

public class ACPCreatorAgreementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorAgreementApi apiInstance = new ACPCreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.editCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementApi#editCreatorAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorAgreementApi;

public class ACPCreatorAgreementApiExample {
    public static void main(String[] args) {
        ACPCreatorAgreementApi apiInstance = new ACPCreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.editCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementApi#editCreatorAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorAgreementApi *apiInstance = [[ACPCreatorAgreementApi alloc] init];

// Edit Creator Agreement
[apiInstance editCreatorAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorAgreementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editCreatorAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class editCreatorAgreementExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorAgreementApi();

            try {
                // Edit Creator Agreement
                oas_any_type_not_mapped result = apiInstance.editCreatorAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorAgreementApi.editCreatorAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorAgreementApi();

try {
    $result = $api_instance->editCreatorAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorAgreementApi->editCreatorAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorAgreementApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorAgreementApi->new();

eval { 
    my $result = $api_instance->editCreatorAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorAgreementApi->editCreatorAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorAgreementApi()

try: 
    # Edit Creator Agreement
    api_response = api_instance.edit_creator_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorAgreementApi->editCreatorAgreement: %s\n" % e)
extern crate ACPCreatorAgreementApi;

pub fn main() {

    let mut context = ACPCreatorAgreementApi::Context::default();
    let result = client.editCreatorAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreatorAgreement

Get Creator Agreement

TODO


/api/acp/v2/creatoragreement

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creatoragreement"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorAgreementApi;

import java.io.File;
import java.util.*;

public class ACPCreatorAgreementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorAgreementApi apiInstance = new ACPCreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementApi#getCreatorAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorAgreementApi;

public class ACPCreatorAgreementApiExample {
    public static void main(String[] args) {
        ACPCreatorAgreementApi apiInstance = new ACPCreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementApi#getCreatorAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorAgreementApi *apiInstance = [[ACPCreatorAgreementApi alloc] init];

// Get Creator Agreement
[apiInstance getCreatorAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorAgreementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorAgreementExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorAgreementApi();

            try {
                // Get Creator Agreement
                oas_any_type_not_mapped result = apiInstance.getCreatorAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorAgreementApi.getCreatorAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorAgreementApi();

try {
    $result = $api_instance->getCreatorAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorAgreementApi->getCreatorAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorAgreementApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorAgreementApi->new();

eval { 
    my $result = $api_instance->getCreatorAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorAgreementApi->getCreatorAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorAgreementApi()

try: 
    # Get Creator Agreement
    api_response = api_instance.get_creator_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorAgreementApi->getCreatorAgreement: %s\n" % e)
extern crate ACPCreatorAgreementApi;

pub fn main() {

    let mut context = ACPCreatorAgreementApi::Context::default();
    let result = client.getCreatorAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listCreatorAgreement

List Creator Agreement

TODO


/api/acp/v2/creatoragreement/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/creatoragreement/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPCreatorAgreementApi;

import java.io.File;
import java.util.*;

public class ACPCreatorAgreementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPCreatorAgreementApi apiInstance = new ACPCreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementApi#listCreatorAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPCreatorAgreementApi;

public class ACPCreatorAgreementApiExample {
    public static void main(String[] args) {
        ACPCreatorAgreementApi apiInstance = new ACPCreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPCreatorAgreementApi#listCreatorAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPCreatorAgreementApi *apiInstance = [[ACPCreatorAgreementApi alloc] init];

// List Creator Agreement
[apiInstance listCreatorAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPCreatorAgreementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCreatorAgreementExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPCreatorAgreementApi();

            try {
                // List Creator Agreement
                oas_any_type_not_mapped result = apiInstance.listCreatorAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPCreatorAgreementApi.listCreatorAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPCreatorAgreementApi();

try {
    $result = $api_instance->listCreatorAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPCreatorAgreementApi->listCreatorAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPCreatorAgreementApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPCreatorAgreementApi->new();

eval { 
    my $result = $api_instance->listCreatorAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPCreatorAgreementApi->listCreatorAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPCreatorAgreementApi()

try: 
    # List Creator Agreement
    api_response = api_instance.list_creator_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPCreatorAgreementApi->listCreatorAgreement: %s\n" % e)
extern crate ACPCreatorAgreementApi;

pub fn main() {

    let mut context = ACPCreatorAgreementApi::Context::default();
    let result = client.listCreatorAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ACPDashboard

getJobStatus

Get Job Status

TODO


/api/acp/v2/dashboard/job/status/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/dashboard/job/status/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPDashboardApi;

import java.io.File;
import java.util.*;

public class ACPDashboardApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPDashboardApi apiInstance = new ACPDashboardApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getJobStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardApi#getJobStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPDashboardApi;

public class ACPDashboardApiExample {
    public static void main(String[] args) {
        ACPDashboardApi apiInstance = new ACPDashboardApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getJobStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardApi#getJobStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPDashboardApi *apiInstance = [[ACPDashboardApi alloc] init];

// Get Job Status
[apiInstance getJobStatusWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPDashboardApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobStatus(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getJobStatusExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPDashboardApi();

            try {
                // Get Job Status
                oas_any_type_not_mapped result = apiInstance.getJobStatus();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPDashboardApi.getJobStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPDashboardApi();

try {
    $result = $api_instance->getJobStatus();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPDashboardApi->getJobStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPDashboardApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPDashboardApi->new();

eval { 
    my $result = $api_instance->getJobStatus();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPDashboardApi->getJobStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPDashboardApi()

try: 
    # Get Job Status
    api_response = api_instance.get_job_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPDashboardApi->getJobStatus: %s\n" % e)
extern crate ACPDashboardApi;

pub fn main() {

    let mut context = ACPDashboardApi::Context::default();
    let result = client.getJobStatus(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


startJob

Start Job

TODO


/api/acp/v2/dashboard/job/start/

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/dashboard/job/start/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPDashboardApi;

import java.io.File;
import java.util.*;

public class ACPDashboardApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPDashboardApi apiInstance = new ACPDashboardApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.startJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardApi#startJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPDashboardApi;

public class ACPDashboardApiExample {
    public static void main(String[] args) {
        ACPDashboardApi apiInstance = new ACPDashboardApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.startJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardApi#startJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPDashboardApi *apiInstance = [[ACPDashboardApi alloc] init];

// Start Job
[apiInstance startJobWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPDashboardApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startJob(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class startJobExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPDashboardApi();

            try {
                // Start Job
                oas_any_type_not_mapped result = apiInstance.startJob();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPDashboardApi.startJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPDashboardApi();

try {
    $result = $api_instance->startJob();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPDashboardApi->startJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPDashboardApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPDashboardApi->new();

eval { 
    my $result = $api_instance->startJob();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPDashboardApi->startJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPDashboardApi()

try: 
    # Start Job
    api_response = api_instance.start_job()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPDashboardApi->startJob: %s\n" % e)
extern crate ACPDashboardApi;

pub fn main() {

    let mut context = ACPDashboardApi::Context::default();
    let result = client.startJob(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


stopJob

Stop Job

TODO


/api/acp/v2/dashboard/job/stop/

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/dashboard/job/stop/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPDashboardApi;

import java.io.File;
import java.util.*;

public class ACPDashboardApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPDashboardApi apiInstance = new ACPDashboardApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.stopJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardApi#stopJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPDashboardApi;

public class ACPDashboardApiExample {
    public static void main(String[] args) {
        ACPDashboardApi apiInstance = new ACPDashboardApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.stopJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPDashboardApi#stopJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPDashboardApi *apiInstance = [[ACPDashboardApi alloc] init];

// Stop Job
[apiInstance stopJobWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPDashboardApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopJob(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class stopJobExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPDashboardApi();

            try {
                // Stop Job
                oas_any_type_not_mapped result = apiInstance.stopJob();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPDashboardApi.stopJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPDashboardApi();

try {
    $result = $api_instance->stopJob();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPDashboardApi->stopJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPDashboardApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPDashboardApi->new();

eval { 
    my $result = $api_instance->stopJob();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPDashboardApi->stopJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPDashboardApi()

try: 
    # Stop Job
    api_response = api_instance.stop_job()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPDashboardApi->stopJob: %s\n" % e)
extern crate ACPDashboardApi;

pub fn main() {

    let mut context = ACPDashboardApi::Context::default();
    let result = client.stopJob(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ACPFAQ

createFaqArticle

Create Faq Article

TODO


/api/acp/v2/article/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/article/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQApi;

import java.io.File;
import java.util.*;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createFaqArticle();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#createFaqArticle");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQApi;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createFaqArticle();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#createFaqArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFAQApi *apiInstance = [[ACPFAQApi alloc] init];

// Create Faq Article
[apiInstance createFaqArticleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFaqArticle(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createFaqArticleExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFAQApi();

            try {
                // Create Faq Article
                oas_any_type_not_mapped result = apiInstance.createFaqArticle();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQApi.createFaqArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQApi();

try {
    $result = $api_instance->createFaqArticle();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQApi->createFaqArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQApi->new();

eval { 
    my $result = $api_instance->createFaqArticle();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQApi->createFaqArticle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQApi()

try: 
    # Create Faq Article
    api_response = api_instance.create_faq_article()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQApi->createFaqArticle: %s\n" % e)
extern crate ACPFAQApi;

pub fn main() {

    let mut context = ACPFAQApi::Context::default();
    let result = client.createFaqArticle(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


createFaqSection

Create Faq Section

TODO


/api/acp/v2/section/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/section/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQApi;

import java.io.File;
import java.util.*;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createFaqSection();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#createFaqSection");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQApi;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createFaqSection();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#createFaqSection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFAQApi *apiInstance = [[ACPFAQApi alloc] init];

// Create Faq Section
[apiInstance createFaqSectionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFaqSection(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createFaqSectionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFAQApi();

            try {
                // Create Faq Section
                oas_any_type_not_mapped result = apiInstance.createFaqSection();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQApi.createFaqSection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQApi();

try {
    $result = $api_instance->createFaqSection();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQApi->createFaqSection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQApi->new();

eval { 
    my $result = $api_instance->createFaqSection();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQApi->createFaqSection: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQApi()

try: 
    # Create Faq Section
    api_response = api_instance.create_faq_section()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQApi->createFaqSection: %s\n" % e)
extern crate ACPFAQApi;

pub fn main() {

    let mut context = ACPFAQApi::Context::default();
    let result = client.createFaqSection(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getFaqArticleDetails

Get Faq Article Details

TODO


/api/acp/v2/article/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/article/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQApi;

import java.io.File;
import java.util.*;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqArticleDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#getFaqArticleDetails");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQApi;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqArticleDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#getFaqArticleDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFAQApi *apiInstance = [[ACPFAQApi alloc] init];

// Get Faq Article Details
[apiInstance getFaqArticleDetailsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqArticleDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFaqArticleDetailsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFAQApi();

            try {
                // Get Faq Article Details
                oas_any_type_not_mapped result = apiInstance.getFaqArticleDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQApi.getFaqArticleDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQApi();

try {
    $result = $api_instance->getFaqArticleDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQApi->getFaqArticleDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQApi->new();

eval { 
    my $result = $api_instance->getFaqArticleDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQApi->getFaqArticleDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQApi()

try: 
    # Get Faq Article Details
    api_response = api_instance.get_faq_article_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQApi->getFaqArticleDetails: %s\n" % e)
extern crate ACPFAQApi;

pub fn main() {

    let mut context = ACPFAQApi::Context::default();
    let result = client.getFaqArticleDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getFaqImages

Get Faq Images

TODO


/api/acp/v2/image/list

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/image/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQApi;

import java.io.File;
import java.util.*;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqImages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#getFaqImages");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQApi;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqImages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#getFaqImages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFAQApi *apiInstance = [[ACPFAQApi alloc] init];

// Get Faq Images
[apiInstance getFaqImagesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqImages(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFaqImagesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFAQApi();

            try {
                // Get Faq Images
                oas_any_type_not_mapped result = apiInstance.getFaqImages();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQApi.getFaqImages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQApi();

try {
    $result = $api_instance->getFaqImages();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQApi->getFaqImages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQApi->new();

eval { 
    my $result = $api_instance->getFaqImages();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQApi->getFaqImages: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQApi()

try: 
    # Get Faq Images
    api_response = api_instance.get_faq_images()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQApi->getFaqImages: %s\n" % e)
extern crate ACPFAQApi;

pub fn main() {

    let mut context = ACPFAQApi::Context::default();
    let result = client.getFaqImages(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getFaqSectionDetails

Get Faq Section Details

TODO


/api/acp/v2/section/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/section/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQApi;

import java.io.File;
import java.util.*;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSectionDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#getFaqSectionDetails");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQApi;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSectionDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#getFaqSectionDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFAQApi *apiInstance = [[ACPFAQApi alloc] init];

// Get Faq Section Details
[apiInstance getFaqSectionDetailsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqSectionDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFaqSectionDetailsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFAQApi();

            try {
                // Get Faq Section Details
                oas_any_type_not_mapped result = apiInstance.getFaqSectionDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQApi.getFaqSectionDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQApi();

try {
    $result = $api_instance->getFaqSectionDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQApi->getFaqSectionDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQApi->new();

eval { 
    my $result = $api_instance->getFaqSectionDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQApi->getFaqSectionDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQApi()

try: 
    # Get Faq Section Details
    api_response = api_instance.get_faq_section_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQApi->getFaqSectionDetails: %s\n" % e)
extern crate ACPFAQApi;

pub fn main() {

    let mut context = ACPFAQApi::Context::default();
    let result = client.getFaqSectionDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getFaqSectionsACP

Get Faq Sections

TODO


/api/acp/v2/section/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/section/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQApi;

import java.io.File;
import java.util.*;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSectionsACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#getFaqSectionsACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQApi;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSectionsACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#getFaqSectionsACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFAQApi *apiInstance = [[ACPFAQApi alloc] init];

// Get Faq Sections
[apiInstance getFaqSectionsACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqSectionsACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFaqSectionsACPExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFAQApi();

            try {
                // Get Faq Sections
                oas_any_type_not_mapped result = apiInstance.getFaqSectionsACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQApi.getFaqSectionsACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQApi();

try {
    $result = $api_instance->getFaqSectionsACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQApi->getFaqSectionsACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQApi->new();

eval { 
    my $result = $api_instance->getFaqSectionsACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQApi->getFaqSectionsACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQApi()

try: 
    # Get Faq Sections
    api_response = api_instance.get_faq_sections_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQApi->getFaqSectionsACP: %s\n" % e)
extern crate ACPFAQApi;

pub fn main() {

    let mut context = ACPFAQApi::Context::default();
    let result = client.getFaqSectionsACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateFaqArticle

Update Faq Article

TODO


/api/acp/v2/article/edit

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/article/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQApi;

import java.io.File;
import java.util.*;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateFaqArticle();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#updateFaqArticle");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQApi;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateFaqArticle();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#updateFaqArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFAQApi *apiInstance = [[ACPFAQApi alloc] init];

// Update Faq Article
[apiInstance updateFaqArticleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateFaqArticle(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateFaqArticleExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFAQApi();

            try {
                // Update Faq Article
                oas_any_type_not_mapped result = apiInstance.updateFaqArticle();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQApi.updateFaqArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQApi();

try {
    $result = $api_instance->updateFaqArticle();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQApi->updateFaqArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQApi->new();

eval { 
    my $result = $api_instance->updateFaqArticle();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQApi->updateFaqArticle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQApi()

try: 
    # Update Faq Article
    api_response = api_instance.update_faq_article()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQApi->updateFaqArticle: %s\n" % e)
extern crate ACPFAQApi;

pub fn main() {

    let mut context = ACPFAQApi::Context::default();
    let result = client.updateFaqArticle(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateFaqSection

Update Faq Section

TODO


/api/acp/v2/section/edit

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/section/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQApi;

import java.io.File;
import java.util.*;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateFaqSection();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#updateFaqSection");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQApi;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateFaqSection();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#updateFaqSection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFAQApi *apiInstance = [[ACPFAQApi alloc] init];

// Update Faq Section
[apiInstance updateFaqSectionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateFaqSection(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateFaqSectionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFAQApi();

            try {
                // Update Faq Section
                oas_any_type_not_mapped result = apiInstance.updateFaqSection();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQApi.updateFaqSection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQApi();

try {
    $result = $api_instance->updateFaqSection();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQApi->updateFaqSection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQApi->new();

eval { 
    my $result = $api_instance->updateFaqSection();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQApi->updateFaqSection: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQApi()

try: 
    # Update Faq Section
    api_response = api_instance.update_faq_section()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQApi->updateFaqSection: %s\n" % e)
extern crate ACPFAQApi;

pub fn main() {

    let mut context = ACPFAQApi::Context::default();
    let result = client.updateFaqSection(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


uploadFaqImage

Upload Faq Image

TODO


/api/acp/v2/image/upload

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/image/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFAQApi;

import java.io.File;
import java.util.*;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadFaqImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#uploadFaqImage");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFAQApi;

public class ACPFAQApiExample {
    public static void main(String[] args) {
        ACPFAQApi apiInstance = new ACPFAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadFaqImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFAQApi#uploadFaqImage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFAQApi *apiInstance = [[ACPFAQApi alloc] init];

// Upload Faq Image
[apiInstance uploadFaqImageWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadFaqImage(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadFaqImageExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFAQApi();

            try {
                // Upload Faq Image
                oas_any_type_not_mapped result = apiInstance.uploadFaqImage();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFAQApi.uploadFaqImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFAQApi();

try {
    $result = $api_instance->uploadFaqImage();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFAQApi->uploadFaqImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFAQApi->new();

eval { 
    my $result = $api_instance->uploadFaqImage();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFAQApi->uploadFaqImage: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFAQApi()

try: 
    # Upload Faq Image
    api_response = api_instance.upload_faq_image()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFAQApi->uploadFaqImage: %s\n" % e)
extern crate ACPFAQApi;

pub fn main() {

    let mut context = ACPFAQApi::Context::default();
    let result = client.uploadFaqImage(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ACPFeature

getFeatureConfigs

Get Feature Configs

TODO


/api/acp/v2/feature/configs

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/feature/configs"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureApi;

import java.io.File;
import java.util.*;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFeatureConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#getFeatureConfigs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureApi;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFeatureConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#getFeatureConfigs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFeatureApi *apiInstance = [[ACPFeatureApi alloc] init];

// Get Feature Configs
[apiInstance getFeatureConfigsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFeatureApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFeatureConfigs(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFeatureConfigsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFeatureApi();

            try {
                // Get Feature Configs
                oas_any_type_not_mapped result = apiInstance.getFeatureConfigs();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureApi.getFeatureConfigs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureApi();

try {
    $result = $api_instance->getFeatureConfigs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureApi->getFeatureConfigs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureApi->new();

eval { 
    my $result = $api_instance->getFeatureConfigs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureApi->getFeatureConfigs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureApi()

try: 
    # Get Feature Configs
    api_response = api_instance.get_feature_configs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureApi->getFeatureConfigs: %s\n" % e)
extern crate ACPFeatureApi;

pub fn main() {

    let mut context = ACPFeatureApi::Context::default();
    let result = client.getFeatureConfigs(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


saveFeature

Save Feature

TODO


/api/acp/v2/feature/save

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/feature/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureApi;

import java.io.File;
import java.util.*;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeature();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeature");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureApi;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeature();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeature");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFeatureApi *apiInstance = [[ACPFeatureApi alloc] init];

// Save Feature
[apiInstance saveFeatureWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFeatureApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeature(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class saveFeatureExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFeatureApi();

            try {
                // Save Feature
                oas_any_type_not_mapped result = apiInstance.saveFeature();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureApi.saveFeature: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureApi();

try {
    $result = $api_instance->saveFeature();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureApi->saveFeature: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureApi->new();

eval { 
    my $result = $api_instance->saveFeature();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureApi->saveFeature: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureApi()

try: 
    # Save Feature
    api_response = api_instance.save_feature()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureApi->saveFeature: %s\n" % e)
extern crate ACPFeatureApi;

pub fn main() {

    let mut context = ACPFeatureApi::Context::default();
    let result = client.saveFeature(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


saveFeatureCategory

Save Feature Category

TODO


/api/acp/v2/feature/category/save

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/feature/category/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureApi;

import java.io.File;
import java.util.*;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureCategory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeatureCategory");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureApi;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureCategory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeatureCategory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFeatureApi *apiInstance = [[ACPFeatureApi alloc] init];

// Save Feature Category
[apiInstance saveFeatureCategoryWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFeatureApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeatureCategory(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class saveFeatureCategoryExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFeatureApi();

            try {
                // Save Feature Category
                oas_any_type_not_mapped result = apiInstance.saveFeatureCategory();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureApi.saveFeatureCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureApi();

try {
    $result = $api_instance->saveFeatureCategory();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureApi->saveFeatureCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureApi->new();

eval { 
    my $result = $api_instance->saveFeatureCategory();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureApi->saveFeatureCategory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureApi()

try: 
    # Save Feature Category
    api_response = api_instance.save_feature_category()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureApi->saveFeatureCategory: %s\n" % e)
extern crate ACPFeatureApi;

pub fn main() {

    let mut context = ACPFeatureApi::Context::default();
    let result = client.saveFeatureCategory(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


saveFeatureDependencies

Save Feature Dependencies

TODO


/api/acp/v2/feature/dependencies/save

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/feature/dependencies/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureApi;

import java.io.File;
import java.util.*;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureDependencies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeatureDependencies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureApi;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureDependencies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeatureDependencies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFeatureApi *apiInstance = [[ACPFeatureApi alloc] init];

// Save Feature Dependencies
[apiInstance saveFeatureDependenciesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFeatureApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeatureDependencies(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class saveFeatureDependenciesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFeatureApi();

            try {
                // Save Feature Dependencies
                oas_any_type_not_mapped result = apiInstance.saveFeatureDependencies();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureApi.saveFeatureDependencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureApi();

try {
    $result = $api_instance->saveFeatureDependencies();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureApi->saveFeatureDependencies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureApi->new();

eval { 
    my $result = $api_instance->saveFeatureDependencies();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureApi->saveFeatureDependencies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureApi()

try: 
    # Save Feature Dependencies
    api_response = api_instance.save_feature_dependencies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureApi->saveFeatureDependencies: %s\n" % e)
extern crate ACPFeatureApi;

pub fn main() {

    let mut context = ACPFeatureApi::Context::default();
    let result = client.saveFeatureDependencies(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


saveFeatureResolution

Save Feature Resolution

TODO


/api/acp/v2/feature/resolution/save

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/feature/resolution/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureApi;

import java.io.File;
import java.util.*;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureResolution();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeatureResolution");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureApi;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureResolution();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeatureResolution");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFeatureApi *apiInstance = [[ACPFeatureApi alloc] init];

// Save Feature Resolution
[apiInstance saveFeatureResolutionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFeatureApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeatureResolution(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class saveFeatureResolutionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFeatureApi();

            try {
                // Save Feature Resolution
                oas_any_type_not_mapped result = apiInstance.saveFeatureResolution();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureApi.saveFeatureResolution: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureApi();

try {
    $result = $api_instance->saveFeatureResolution();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureApi->saveFeatureResolution: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureApi->new();

eval { 
    my $result = $api_instance->saveFeatureResolution();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureApi->saveFeatureResolution: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureApi()

try: 
    # Save Feature Resolution
    api_response = api_instance.save_feature_resolution()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureApi->saveFeatureResolution: %s\n" % e)
extern crate ACPFeatureApi;

pub fn main() {

    let mut context = ACPFeatureApi::Context::default();
    let result = client.saveFeatureResolution(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


saveFeatureType

Save Feature Type

TODO


/api/acp/v2/feature/type/save

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/feature/type/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPFeatureApi;

import java.io.File;
import java.util.*;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureType();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeatureType");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPFeatureApi;

public class ACPFeatureApiExample {
    public static void main(String[] args) {
        ACPFeatureApi apiInstance = new ACPFeatureApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveFeatureType();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPFeatureApi#saveFeatureType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPFeatureApi *apiInstance = [[ACPFeatureApi alloc] init];

// Save Feature Type
[apiInstance saveFeatureTypeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPFeatureApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveFeatureType(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class saveFeatureTypeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPFeatureApi();

            try {
                // Save Feature Type
                oas_any_type_not_mapped result = apiInstance.saveFeatureType();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPFeatureApi.saveFeatureType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPFeatureApi();

try {
    $result = $api_instance->saveFeatureType();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPFeatureApi->saveFeatureType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPFeatureApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPFeatureApi->new();

eval { 
    my $result = $api_instance->saveFeatureType();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPFeatureApi->saveFeatureType: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPFeatureApi()

try: 
    # Save Feature Type
    api_response = api_instance.save_feature_type()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPFeatureApi->saveFeatureType: %s\n" % e)
extern crate ACPFeatureApi;

pub fn main() {

    let mut context = ACPFeatureApi::Context::default();
    let result = client.saveFeatureType(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ACPModerator

addCreatorModeratorACP

Add Creator Moderator

TODO


/api/acp/v2/moderator/creator/add/

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/moderator/creator/add/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorApi;

import java.io.File;
import java.util.*;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#addCreatorModeratorACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorApi;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#addCreatorModeratorACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPModeratorApi *apiInstance = [[ACPModeratorApi alloc] init];

// Add Creator Moderator
[apiInstance addCreatorModeratorACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPModeratorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCreatorModeratorACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addCreatorModeratorACPExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPModeratorApi();

            try {
                // Add Creator Moderator
                oas_any_type_not_mapped result = apiInstance.addCreatorModeratorACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorApi.addCreatorModeratorACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorApi();

try {
    $result = $api_instance->addCreatorModeratorACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorApi->addCreatorModeratorACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorApi->new();

eval { 
    my $result = $api_instance->addCreatorModeratorACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorApi->addCreatorModeratorACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorApi()

try: 
    # Add Creator Moderator
    api_response = api_instance.add_creator_moderator_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorApi->addCreatorModeratorACP: %s\n" % e)
extern crate ACPModeratorApi;

pub fn main() {

    let mut context = ACPModeratorApi::Context::default();
    let result = client.addCreatorModeratorACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


createModerator

Create Moderator

TODO


/api/acp/v2/moderator/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/moderator/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorApi;

import java.io.File;
import java.util.*;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#createModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorApi;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#createModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPModeratorApi *apiInstance = [[ACPModeratorApi alloc] init];

// Create Moderator
[apiInstance createModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPModeratorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createModeratorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPModeratorApi();

            try {
                // Create Moderator
                oas_any_type_not_mapped result = apiInstance.createModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorApi.createModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorApi();

try {
    $result = $api_instance->createModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorApi->createModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorApi->new();

eval { 
    my $result = $api_instance->createModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorApi->createModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorApi()

try: 
    # Create Moderator
    api_response = api_instance.create_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorApi->createModerator: %s\n" % e)
extern crate ACPModeratorApi;

pub fn main() {

    let mut context = ACPModeratorApi::Context::default();
    let result = client.createModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getModeratorAvailableCreators

Get Moderator Available Creators

TODO


/api/acp/v2/moderator/creator/available

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/moderator/creator/available"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorApi;

import java.io.File;
import java.util.*;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorAvailableCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#getModeratorAvailableCreators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorApi;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorAvailableCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#getModeratorAvailableCreators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPModeratorApi *apiInstance = [[ACPModeratorApi alloc] init];

// Get Moderator Available Creators
[apiInstance getModeratorAvailableCreatorsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPModeratorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModeratorAvailableCreators(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getModeratorAvailableCreatorsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPModeratorApi();

            try {
                // Get Moderator Available Creators
                oas_any_type_not_mapped result = apiInstance.getModeratorAvailableCreators();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorApi.getModeratorAvailableCreators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorApi();

try {
    $result = $api_instance->getModeratorAvailableCreators();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorApi->getModeratorAvailableCreators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorApi->new();

eval { 
    my $result = $api_instance->getModeratorAvailableCreators();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorApi->getModeratorAvailableCreators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorApi()

try: 
    # Get Moderator Available Creators
    api_response = api_instance.get_moderator_available_creators()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorApi->getModeratorAvailableCreators: %s\n" % e)
extern crate ACPModeratorApi;

pub fn main() {

    let mut context = ACPModeratorApi::Context::default();
    let result = client.getModeratorAvailableCreators(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getModeratorCreators

Get Moderator Creators

TODO


/api/acp/v2/moderator/creator/list/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/moderator/creator/list/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorApi;

import java.io.File;
import java.util.*;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#getModeratorCreators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorApi;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#getModeratorCreators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPModeratorApi *apiInstance = [[ACPModeratorApi alloc] init];

// Get Moderator Creators
[apiInstance getModeratorCreatorsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPModeratorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModeratorCreators(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getModeratorCreatorsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPModeratorApi();

            try {
                // Get Moderator Creators
                oas_any_type_not_mapped result = apiInstance.getModeratorCreators();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorApi.getModeratorCreators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorApi();

try {
    $result = $api_instance->getModeratorCreators();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorApi->getModeratorCreators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorApi->new();

eval { 
    my $result = $api_instance->getModeratorCreators();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorApi->getModeratorCreators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorApi()

try: 
    # Get Moderator Creators
    api_response = api_instance.get_moderator_creators()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorApi->getModeratorCreators: %s\n" % e)
extern crate ACPModeratorApi;

pub fn main() {

    let mut context = ACPModeratorApi::Context::default();
    let result = client.getModeratorCreators(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getModeratorList

Get Moderator List

TODO


/api/acp/v2/moderator/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/moderator/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorApi;

import java.io.File;
import java.util.*;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#getModeratorList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorApi;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getModeratorList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#getModeratorList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPModeratorApi *apiInstance = [[ACPModeratorApi alloc] init];

// Get Moderator List
[apiInstance getModeratorListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPModeratorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModeratorList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getModeratorListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPModeratorApi();

            try {
                // Get Moderator List
                oas_any_type_not_mapped result = apiInstance.getModeratorList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorApi.getModeratorList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorApi();

try {
    $result = $api_instance->getModeratorList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorApi->getModeratorList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorApi->new();

eval { 
    my $result = $api_instance->getModeratorList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorApi->getModeratorList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorApi()

try: 
    # Get Moderator List
    api_response = api_instance.get_moderator_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorApi->getModeratorList: %s\n" % e)
extern crate ACPModeratorApi;

pub fn main() {

    let mut context = ACPModeratorApi::Context::default();
    let result = client.getModeratorList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


removeCreatorModeratorACP

Remove Creator Moderator

TODO


/api/acp/v2/moderator/creator/remove

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/moderator/creator/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorApi;

import java.io.File;
import java.util.*;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#removeCreatorModeratorACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorApi;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#removeCreatorModeratorACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPModeratorApi *apiInstance = [[ACPModeratorApi alloc] init];

// Remove Creator Moderator
[apiInstance removeCreatorModeratorACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPModeratorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeCreatorModeratorACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class removeCreatorModeratorACPExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPModeratorApi();

            try {
                // Remove Creator Moderator
                oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorApi.removeCreatorModeratorACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorApi();

try {
    $result = $api_instance->removeCreatorModeratorACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorApi->removeCreatorModeratorACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorApi->new();

eval { 
    my $result = $api_instance->removeCreatorModeratorACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorApi->removeCreatorModeratorACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorApi()

try: 
    # Remove Creator Moderator
    api_response = api_instance.remove_creator_moderator_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorApi->removeCreatorModeratorACP: %s\n" % e)
extern crate ACPModeratorApi;

pub fn main() {

    let mut context = ACPModeratorApi::Context::default();
    let result = client.removeCreatorModeratorACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateGlobalModerator

Update Global Moderator

TODO


/api/acp/v2/moderator/update/global

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/moderator/update/global"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPModeratorApi;

import java.io.File;
import java.util.*;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#updateGlobalModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPModeratorApi;

public class ACPModeratorApiExample {
    public static void main(String[] args) {
        ACPModeratorApi apiInstance = new ACPModeratorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPModeratorApi#updateGlobalModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPModeratorApi *apiInstance = [[ACPModeratorApi alloc] init];

// Update Global Moderator
[apiInstance updateGlobalModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPModeratorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateGlobalModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateGlobalModeratorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPModeratorApi();

            try {
                // Update Global Moderator
                oas_any_type_not_mapped result = apiInstance.updateGlobalModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPModeratorApi.updateGlobalModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPModeratorApi();

try {
    $result = $api_instance->updateGlobalModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPModeratorApi->updateGlobalModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPModeratorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPModeratorApi->new();

eval { 
    my $result = $api_instance->updateGlobalModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPModeratorApi->updateGlobalModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPModeratorApi()

try: 
    # Update Global Moderator
    api_response = api_instance.update_global_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPModeratorApi->updateGlobalModerator: %s\n" % e)
extern crate ACPModeratorApi;

pub fn main() {

    let mut context = ACPModeratorApi::Context::default();
    let result = client.updateGlobalModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ACPTranscoding

augmentOrder

Augment Order

TODO


/acp/v3/order/augment

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/order/augment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.augmentOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#augmentOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.augmentOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#augmentOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Augment Order
[apiInstance augmentOrderWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.augmentOrder(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class augmentOrderExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Augment Order
                oas_any_type_not_mapped result = apiInstance.augmentOrder();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.augmentOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->augmentOrder();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->augmentOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->augmentOrder();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->augmentOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Augment Order
    api_response = api_instance.augment_order()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->augmentOrder: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.augmentOrder(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


createOrder

Create Order

TODO


/acp/v3/order/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/order/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#createOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#createOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Create Order
[apiInstance createOrderWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createOrder(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createOrderExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Create Order
                oas_any_type_not_mapped result = apiInstance.createOrder();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.createOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->createOrder();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->createOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->createOrder();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->createOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Create Order
    api_response = api_instance.create_order()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->createOrder: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.createOrder(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getContentACP

Get Content

TODO


/acp/v3/content

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/content"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getContentACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getContentACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getContentACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getContentACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Get Content
[apiInstance getContentACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContentACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getContentACPExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Get Content
                oas_any_type_not_mapped result = apiInstance.getContentACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.getContentACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->getContentACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->getContentACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->getContentACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->getContentACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Get Content
    api_response = api_instance.get_content_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->getContentACP: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.getContentACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getContentList

Get Content List

TODO


/acp/v3/content/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/content/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getContentList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getContentList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getContentList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getContentList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Get Content List
[apiInstance getContentListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContentList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getContentListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Get Content List
                oas_any_type_not_mapped result = apiInstance.getContentList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.getContentList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->getContentList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->getContentList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->getContentList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->getContentList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Get Content List
    api_response = api_instance.get_content_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->getContentList: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.getContentList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getJob

Get Job

TODO


/acp/v3/job

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/job"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Get Job
[apiInstance getJobWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJob(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getJobExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Get Job
                oas_any_type_not_mapped result = apiInstance.getJob();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.getJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->getJob();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->getJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->getJob();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->getJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Get Job
    api_response = api_instance.get_job()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->getJob: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.getJob(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getOrder

Get Order

TODO


/acp/v3/order

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/order"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Get Order
[apiInstance getOrderWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrder(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getOrderExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Get Order
                oas_any_type_not_mapped result = apiInstance.getOrder();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.getOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->getOrder();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->getOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->getOrder();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->getOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Get Order
    api_response = api_instance.get_order()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->getOrder: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.getOrder(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getOrderList

Get Order List

TODO


/acp/v3/order/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/order/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getOrderList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getOrderList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getOrderList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getOrderList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Get Order List
[apiInstance getOrderListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getOrderListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Get Order List
                oas_any_type_not_mapped result = apiInstance.getOrderList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.getOrderList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->getOrderList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->getOrderList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->getOrderList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->getOrderList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Get Order List
    api_response = api_instance.get_order_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->getOrderList: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.getOrderList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getTask

Get Task

TODO


/acp/v3/task

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/task"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getTask();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getTask");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getTask();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getTask");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Get Task
[apiInstance getTaskWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTask(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTaskExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Get Task
                oas_any_type_not_mapped result = apiInstance.getTask();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.getTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->getTask();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->getTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->getTask();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->getTask: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Get Task
    api_response = api_instance.get_task()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->getTask: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.getTask(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUpload

Get Upload

TODO


/acp/v3/upload

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUpload();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getUpload");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUpload();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Get Upload
[apiInstance getUploadWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUpload(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUploadExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Get Upload
                oas_any_type_not_mapped result = apiInstance.getUpload();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.getUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->getUpload();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->getUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->getUpload();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->getUpload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Get Upload
    api_response = api_instance.get_upload()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->getUpload: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.getUpload(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUploadList

Get Upload List

TODO


/acp/v3/upload/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/upload/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUploadList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getUploadList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUploadList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#getUploadList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Get Upload List
[apiInstance getUploadListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUploadList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUploadListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Get Upload List
                oas_any_type_not_mapped result = apiInstance.getUploadList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.getUploadList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->getUploadList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->getUploadList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->getUploadList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->getUploadList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Get Upload List
    api_response = api_instance.get_upload_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->getUploadList: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.getUploadList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


postContent

Post Content

TODO


/acp/v3/content

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/content"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Post Content
[apiInstance postContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Post Content
                oas_any_type_not_mapped result = apiInstance.postContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.postContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->postContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->postContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->postContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->postContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Post Content
    api_response = api_instance.post_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->postContent: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.postContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


postJob

Post Job

TODO


/acp/v3/job

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/job"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postJob();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Post Job
[apiInstance postJobWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postJob(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postJobExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Post Job
                oas_any_type_not_mapped result = apiInstance.postJob();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.postJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->postJob();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->postJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->postJob();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->postJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Post Job
    api_response = api_instance.post_job()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->postJob: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.postJob(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


postManager

Post Manager

TODO


/acp/v3/manager

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/manager"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postManager();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postManager");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postManager();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postManager");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Post Manager
[apiInstance postManagerWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postManager(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postManagerExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Post Manager
                oas_any_type_not_mapped result = apiInstance.postManager();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.postManager: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->postManager();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->postManager: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->postManager();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->postManager: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Post Manager
    api_response = api_instance.post_manager()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->postManager: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.postManager(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


postOrder

Post Order

TODO


/acp/v3/order

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/order"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postOrder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Post Order
[apiInstance postOrderWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postOrder(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postOrderExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Post Order
                oas_any_type_not_mapped result = apiInstance.postOrder();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.postOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->postOrder();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->postOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->postOrder();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->postOrder: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Post Order
    api_response = api_instance.post_order()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->postOrder: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.postOrder(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


postTask

Post Task

TODO


/acp/v3/task

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/task"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postTask();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postTask");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postTask();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postTask");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Post Task
[apiInstance postTaskWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postTask(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postTaskExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Post Task
                oas_any_type_not_mapped result = apiInstance.postTask();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.postTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->postTask();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->postTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->postTask();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->postTask: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Post Task
    api_response = api_instance.post_task()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->postTask: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.postTask(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


postUpload

Post Upload

TODO


/acp/v3/upload

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/acp/v3/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPTranscodingApi;

import java.io.File;
import java.util.*;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postUpload();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postUpload");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPTranscodingApi;

public class ACPTranscodingApiExample {
    public static void main(String[] args) {
        ACPTranscodingApi apiInstance = new ACPTranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.postUpload();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPTranscodingApi#postUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPTranscodingApi *apiInstance = [[ACPTranscodingApi alloc] init];

// Post Upload
[apiInstance postUploadWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPTranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postUpload(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postUploadExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPTranscodingApi();

            try {
                // Post Upload
                oas_any_type_not_mapped result = apiInstance.postUpload();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPTranscodingApi.postUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPTranscodingApi();

try {
    $result = $api_instance->postUpload();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPTranscodingApi->postUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPTranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPTranscodingApi->new();

eval { 
    my $result = $api_instance->postUpload();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPTranscodingApi->postUpload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPTranscodingApi()

try: 
    # Post Upload
    api_response = api_instance.post_upload()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPTranscodingApi->postUpload: %s\n" % e)
extern crate ACPTranscodingApi;

pub fn main() {

    let mut context = ACPTranscodingApi::Context::default();
    let result = client.postUpload(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ACPUser

addUserSubscriptions

Add User Subscriptions

TODO


/api/acp/v2/user/subscription/add

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/subscription/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addUserSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#addUserSubscriptions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addUserSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#addUserSubscriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Add User Subscriptions
[apiInstance addUserSubscriptionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addUserSubscriptions(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addUserSubscriptionsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Add User Subscriptions
                oas_any_type_not_mapped result = apiInstance.addUserSubscriptions();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.addUserSubscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->addUserSubscriptions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->addUserSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->addUserSubscriptions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->addUserSubscriptions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Add User Subscriptions
    api_response = api_instance.add_user_subscriptions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->addUserSubscriptions: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.addUserSubscriptions(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


checkEmailAvailable

Check Email Available

TODO


/api/acp/v2/user/email/availability

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/email/availability"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.checkEmailAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#checkEmailAvailable");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.checkEmailAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#checkEmailAvailable");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Check Email Available
[apiInstance checkEmailAvailableWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkEmailAvailable(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class checkEmailAvailableExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Check Email Available
                oas_any_type_not_mapped result = apiInstance.checkEmailAvailable();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.checkEmailAvailable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->checkEmailAvailable();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->checkEmailAvailable: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->checkEmailAvailable();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->checkEmailAvailable: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Check Email Available
    api_response = api_instance.check_email_available()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->checkEmailAvailable: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.checkEmailAvailable(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


checkUsernameAvailable

Check Username Available

TODO


/api/acp/v2/user/username/availability

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/username/availability"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.checkUsernameAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#checkUsernameAvailable");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.checkUsernameAvailable();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#checkUsernameAvailable");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Check Username Available
[apiInstance checkUsernameAvailableWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkUsernameAvailable(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class checkUsernameAvailableExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Check Username Available
                oas_any_type_not_mapped result = apiInstance.checkUsernameAvailable();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.checkUsernameAvailable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->checkUsernameAvailable();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->checkUsernameAvailable: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->checkUsernameAvailable();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->checkUsernameAvailable: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Check Username Available
    api_response = api_instance.check_username_available()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->checkUsernameAvailable: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.checkUsernameAvailable(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


createAdmin

Create Admin

TODO


/api/acp/v2/user/admin/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/admin/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#createAdmin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#createAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Create Admin
[apiInstance createAdminWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAdmin(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createAdminExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Create Admin
                oas_any_type_not_mapped result = apiInstance.createAdmin();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.createAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->createAdmin();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->createAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->createAdmin();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->createAdmin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Create Admin
    api_response = api_instance.create_admin()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->createAdmin: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.createAdmin(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


deleteUser

Delete User

TODO


/api/acp/v2/user/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#deleteUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Delete User
[apiInstance deleteUserWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteUser(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Delete User
                oas_any_type_not_mapped result = apiInstance.deleteUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->deleteUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->deleteUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Delete User
    api_response = api_instance.delete_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->deleteUser: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.deleteUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


findUser

Find User

TODO


/api/acp/v2/user/find

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/find"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.findUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#findUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.findUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#findUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Find User
[apiInstance findUserWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findUser(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class findUserExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Find User
                oas_any_type_not_mapped result = apiInstance.findUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.findUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->findUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->findUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->findUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->findUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Find User
    api_response = api_instance.find_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->findUser: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.findUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getPaymentProcessorData

Get Payment Processor Data

TODO


/api/acp/v2/user/payment/processor/data

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/payment/processor/data"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPaymentProcessorData();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getPaymentProcessorData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPaymentProcessorData();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getPaymentProcessorData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Get Payment Processor Data
[apiInstance getPaymentProcessorDataWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPaymentProcessorData(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPaymentProcessorDataExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Get Payment Processor Data
                oas_any_type_not_mapped result = apiInstance.getPaymentProcessorData();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.getPaymentProcessorData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->getPaymentProcessorData();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->getPaymentProcessorData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->getPaymentProcessorData();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->getPaymentProcessorData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Get Payment Processor Data
    api_response = api_instance.get_payment_processor_data()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->getPaymentProcessorData: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.getPaymentProcessorData(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getSubjectAccessData

Get Subject Access Data

TODO


/api/acp/v3/user/sar

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v3/user/sar"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getSubjectAccessData();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getSubjectAccessData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getSubjectAccessData();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getSubjectAccessData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Get Subject Access Data
[apiInstance getSubjectAccessDataWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSubjectAccessData(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSubjectAccessDataExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Get Subject Access Data
                oas_any_type_not_mapped result = apiInstance.getSubjectAccessData();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.getSubjectAccessData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->getSubjectAccessData();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->getSubjectAccessData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->getSubjectAccessData();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->getSubjectAccessData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Get Subject Access Data
    api_response = api_instance.get_subject_access_data()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->getSubjectAccessData: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.getSubjectAccessData(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUserDetails

Get User Details

TODO


/api/acp/v2/user/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getUserDetails");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getUserDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Get User Details
[apiInstance getUserDetailsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserDetailsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Get User Details
                oas_any_type_not_mapped result = apiInstance.getUserDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.getUserDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->getUserDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->getUserDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->getUserDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->getUserDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Get User Details
    api_response = api_instance.get_user_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->getUserDetails: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.getUserDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUserList

Get User List

TODO


/api/acp/v2/user/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getUserList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getUserList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Get User List
[apiInstance getUserListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Get User List
                oas_any_type_not_mapped result = apiInstance.getUserList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.getUserList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->getUserList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->getUserList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->getUserList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->getUserList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Get User List
    api_response = api_instance.get_user_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->getUserList: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.getUserList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUserSubscriptions

Get User Subscriptions

TODO


/api/acp/v2/user/usersubscription/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/usersubscription/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getUserSubscriptions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#getUserSubscriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Get User Subscriptions
[apiInstance getUserSubscriptionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserSubscriptions(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserSubscriptionsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Get User Subscriptions
                oas_any_type_not_mapped result = apiInstance.getUserSubscriptions();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.getUserSubscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->getUserSubscriptions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->getUserSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->getUserSubscriptions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->getUserSubscriptions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Get User Subscriptions
    api_response = api_instance.get_user_subscriptions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->getUserSubscriptions: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.getUserSubscriptions(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listUserInvoices

List User Invoices

TODO


/api/acp/v2/user/payment/invoice/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/payment/invoice/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listUserInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#listUserInvoices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listUserInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#listUserInvoices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// List User Invoices
[apiInstance listUserInvoicesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUserInvoices(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listUserInvoicesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // List User Invoices
                oas_any_type_not_mapped result = apiInstance.listUserInvoices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.listUserInvoices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->listUserInvoices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->listUserInvoices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->listUserInvoices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->listUserInvoices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # List User Invoices
    api_response = api_instance.list_user_invoices()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->listUserInvoices: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.listUserInvoices(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


removeUserSubscription

Remove User Subscription

TODO


/api/acp/v2/user/usersubscription/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/usersubscription/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeUserSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#removeUserSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeUserSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#removeUserSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Remove User Subscription
[apiInstance removeUserSubscriptionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeUserSubscription(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class removeUserSubscriptionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Remove User Subscription
                oas_any_type_not_mapped result = apiInstance.removeUserSubscription();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.removeUserSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->removeUserSubscription();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->removeUserSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->removeUserSubscription();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->removeUserSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Remove User Subscription
    api_response = api_instance.remove_user_subscription()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->removeUserSubscription: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.removeUserSubscription(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


scheduleDeletionACP

Schedule Deletion

TODO


/api/acp/v3/user/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v3/user/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.scheduleDeletionACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#scheduleDeletionACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.scheduleDeletionACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#scheduleDeletionACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Schedule Deletion
[apiInstance scheduleDeletionACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.scheduleDeletionACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class scheduleDeletionACPExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Schedule Deletion
                oas_any_type_not_mapped result = apiInstance.scheduleDeletionACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.scheduleDeletionACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->scheduleDeletionACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->scheduleDeletionACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->scheduleDeletionACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->scheduleDeletionACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Schedule Deletion
    api_response = api_instance.schedule_deletion_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->scheduleDeletionACP: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.scheduleDeletionACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


searchUserForModeration

Search User For Moderation

TODO


/api/acp/v2/user/list/notmoderator

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/list/notmoderator"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.searchUserForModeration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#searchUserForModeration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.searchUserForModeration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#searchUserForModeration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Search User For Moderation
[apiInstance searchUserForModerationWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchUserForModeration(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchUserForModerationExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Search User For Moderation
                oas_any_type_not_mapped result = apiInstance.searchUserForModeration();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.searchUserForModeration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->searchUserForModeration();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->searchUserForModeration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->searchUserForModeration();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->searchUserForModeration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Search User For Moderation
    api_response = api_instance.search_user_for_moderation()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->searchUserForModeration: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.searchUserForModeration(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


signupACP

Signup

TODO


/api/acp/v2/user/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.signupACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#signupACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.signupACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#signupACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Signup
[apiInstance signupACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signupACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class signupACPExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Signup
                oas_any_type_not_mapped result = apiInstance.signupACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.signupACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->signupACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->signupACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->signupACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->signupACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Signup
    api_response = api_instance.signup_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->signupACP: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.signupACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


unscheduleDeletionACP

Unschedule Deletion

TODO


/api/acp/v3/user/undelete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v3/user/undelete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unscheduleDeletionACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#unscheduleDeletionACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unscheduleDeletionACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#unscheduleDeletionACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Unschedule Deletion
[apiInstance unscheduleDeletionACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unscheduleDeletionACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unscheduleDeletionACPExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Unschedule Deletion
                oas_any_type_not_mapped result = apiInstance.unscheduleDeletionACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.unscheduleDeletionACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->unscheduleDeletionACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->unscheduleDeletionACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->unscheduleDeletionACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->unscheduleDeletionACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Unschedule Deletion
    api_response = api_instance.unschedule_deletion_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->unscheduleDeletionACP: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.unscheduleDeletionACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateAdministrator

Update Administrator

TODO


/api/acp/v2/user/administrator/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/administrator/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateAdministrator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#updateAdministrator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateAdministrator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#updateAdministrator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Update Administrator
[apiInstance updateAdministratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAdministrator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateAdministratorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Update Administrator
                oas_any_type_not_mapped result = apiInstance.updateAdministrator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.updateAdministrator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->updateAdministrator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->updateAdministrator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->updateAdministrator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->updateAdministrator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Update Administrator
    api_response = api_instance.update_administrator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->updateAdministrator: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.updateAdministrator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateUser

Update User

TODO


/api/acp/v2/user/edit

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#updateUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Update User
[apiInstance updateUserWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUser(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Update User
                oas_any_type_not_mapped result = apiInstance.updateUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->updateUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->updateUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Update User
    api_response = api_instance.update_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->updateUser: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.updateUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


uploadAvatarACP

Upload Avatar

TODO


/api/acp/v2/user/avatar/upload

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/acp/v2/user/avatar/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ACPUserApi;

import java.io.File;
import java.util.*;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadAvatarACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#uploadAvatarACP");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ACPUserApi;

public class ACPUserApiExample {
    public static void main(String[] args) {
        ACPUserApi apiInstance = new ACPUserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadAvatarACP();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACPUserApi#uploadAvatarACP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ACPUserApi *apiInstance = [[ACPUserApi alloc] init];

// Upload Avatar
[apiInstance uploadAvatarACPWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ACPUserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadAvatarACP(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadAvatarACPExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ACPUserApi();

            try {
                // Upload Avatar
                oas_any_type_not_mapped result = apiInstance.uploadAvatarACP();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ACPUserApi.uploadAvatarACP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ACPUserApi();

try {
    $result = $api_instance->uploadAvatarACP();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACPUserApi->uploadAvatarACP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ACPUserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ACPUserApi->new();

eval { 
    my $result = $api_instance->uploadAvatarACP();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACPUserApi->uploadAvatarACP: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ACPUserApi()

try: 
    # Upload Avatar
    api_response = api_instance.upload_avatar_acp()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACPUserApi->uploadAvatarACP: %s\n" % e)
extern crate ACPUserApi;

pub fn main() {

    let mut context = ACPUserApi::Context::default();
    let result = client.uploadAvatarACP(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Activation

confirmEmail

Confirm Email

TODO


/api/v2/activation/email/confirm

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/activation/email/confirm"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActivationApi;

import java.io.File;
import java.util.*;

public class ActivationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ActivationApi apiInstance = new ActivationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.confirmEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivationApi#confirmEmail");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActivationApi;

public class ActivationApiExample {
    public static void main(String[] args) {
        ActivationApi apiInstance = new ActivationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.confirmEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivationApi#confirmEmail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ActivationApi *apiInstance = [[ActivationApi alloc] init];

// Confirm Email
[apiInstance confirmEmailWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ActivationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmEmail(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class confirmEmailExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ActivationApi();

            try {
                // Confirm Email
                oas_any_type_not_mapped result = apiInstance.confirmEmail();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActivationApi.confirmEmail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ActivationApi();

try {
    $result = $api_instance->confirmEmail();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivationApi->confirmEmail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ActivationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ActivationApi->new();

eval { 
    my $result = $api_instance->confirmEmail();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActivationApi->confirmEmail: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ActivationApi()

try: 
    # Confirm Email
    api_response = api_instance.confirm_email()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActivationApi->confirmEmail: %s\n" % e)
extern crate ActivationApi;

pub fn main() {

    let mut context = ActivationApi::Context::default();
    let result = client.confirmEmail(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


requestActivationEmail

Request Activation Email

TODO


/api/v2/activation/email/request

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/activation/email/request"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActivationApi;

import java.io.File;
import java.util.*;

public class ActivationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ActivationApi apiInstance = new ActivationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.requestActivationEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivationApi#requestActivationEmail");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActivationApi;

public class ActivationApiExample {
    public static void main(String[] args) {
        ActivationApi apiInstance = new ActivationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.requestActivationEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivationApi#requestActivationEmail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ActivationApi *apiInstance = [[ActivationApi alloc] init];

// Request Activation Email
[apiInstance requestActivationEmailWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ActivationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.requestActivationEmail(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class requestActivationEmailExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ActivationApi();

            try {
                // Request Activation Email
                oas_any_type_not_mapped result = apiInstance.requestActivationEmail();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActivationApi.requestActivationEmail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ActivationApi();

try {
    $result = $api_instance->requestActivationEmail();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivationApi->requestActivationEmail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ActivationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ActivationApi->new();

eval { 
    my $result = $api_instance->requestActivationEmail();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActivationApi->requestActivationEmail: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ActivationApi()

try: 
    # Request Activation Email
    api_response = api_instance.request_activation_email()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActivationApi->requestActivationEmail: %s\n" % e)
extern crate ActivationApi;

pub fn main() {

    let mut context = ActivationApi::Context::default();
    let result = client.requestActivationEmail(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Administration

addGlobalModerator

Add Global Moderator

TODO


/api/v2/administration/moderators/global/add

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/administration/moderators/global/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationApi;

import java.io.File;
import java.util.*;

public class AdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AdministrationApi apiInstance = new AdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#addGlobalModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationApi;

public class AdministrationApiExample {
    public static void main(String[] args) {
        AdministrationApi apiInstance = new AdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#addGlobalModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AdministrationApi *apiInstance = [[AdministrationApi alloc] init];

// Add Global Moderator
[apiInstance addGlobalModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AdministrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addGlobalModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addGlobalModeratorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AdministrationApi();

            try {
                // Add Global Moderator
                oas_any_type_not_mapped result = apiInstance.addGlobalModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationApi.addGlobalModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationApi();

try {
    $result = $api_instance->addGlobalModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationApi->addGlobalModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationApi->new();

eval { 
    my $result = $api_instance->addGlobalModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationApi->addGlobalModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationApi()

try: 
    # Add Global Moderator
    api_response = api_instance.add_global_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->addGlobalModerator: %s\n" % e)
extern crate AdministrationApi;

pub fn main() {

    let mut context = AdministrationApi::Context::default();
    let result = client.addGlobalModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getModerator

Get Moderator

TODO


/api/v2/administration/moderators/get/{user}

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/administration/moderators/get/{user}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationApi;

import java.io.File;
import java.util.*;

public class AdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AdministrationApi apiInstance = new AdministrationApi();
        String user = user_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.getModerator(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#getModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationApi;

public class AdministrationApiExample {
    public static void main(String[] args) {
        AdministrationApi apiInstance = new AdministrationApi();
        String user = user_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.getModerator(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#getModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AdministrationApi *apiInstance = [[AdministrationApi alloc] init];
String *user = user_example; //  (default to null)

// Get Moderator
[apiInstance getModeratorWith:user
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AdministrationApi()
var user = user_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModerator(user, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getModeratorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AdministrationApi();
            var user = user_example;  // String |  (default to null)

            try {
                // Get Moderator
                oas_any_type_not_mapped result = apiInstance.getModerator(user);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationApi.getModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationApi();
$user = user_example; // String | 

try {
    $result = $api_instance->getModerator($user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationApi->getModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationApi->new();
my $user = user_example; # String | 

eval { 
    my $result = $api_instance->getModerator(user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationApi->getModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationApi()
user = user_example # String |  (default to null)

try: 
    # Get Moderator
    api_response = api_instance.get_moderator(user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->getModerator: %s\n" % e)
extern crate AdministrationApi;

pub fn main() {
    let user = user_example; // String

    let mut context = AdministrationApi::Context::default();
    let result = client.getModerator(user, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
user*
String
Required

Responses


listModeratorsAdmin

List Moderators

TODO


/api/v2/administration/moderators/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/administration/moderators/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationApi;

import java.io.File;
import java.util.*;

public class AdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AdministrationApi apiInstance = new AdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listModeratorsAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#listModeratorsAdmin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationApi;

public class AdministrationApiExample {
    public static void main(String[] args) {
        AdministrationApi apiInstance = new AdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listModeratorsAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#listModeratorsAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AdministrationApi *apiInstance = [[AdministrationApi alloc] init];

// List Moderators
[apiInstance listModeratorsAdminWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AdministrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModeratorsAdmin(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listModeratorsAdminExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AdministrationApi();

            try {
                // List Moderators
                oas_any_type_not_mapped result = apiInstance.listModeratorsAdmin();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationApi.listModeratorsAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationApi();

try {
    $result = $api_instance->listModeratorsAdmin();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationApi->listModeratorsAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationApi->new();

eval { 
    my $result = $api_instance->listModeratorsAdmin();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationApi->listModeratorsAdmin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationApi()

try: 
    # List Moderators
    api_response = api_instance.list_moderators_admin()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->listModeratorsAdmin: %s\n" % e)
extern crate AdministrationApi;

pub fn main() {

    let mut context = AdministrationApi::Context::default();
    let result = client.listModeratorsAdmin(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


removeGlobalModerator

Remove Global Moderator

TODO


/api/v2/administration/moderators/global/remove

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/administration/moderators/global/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationApi;

import java.io.File;
import java.util.*;

public class AdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AdministrationApi apiInstance = new AdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#removeGlobalModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationApi;

public class AdministrationApiExample {
    public static void main(String[] args) {
        AdministrationApi apiInstance = new AdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeGlobalModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#removeGlobalModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AdministrationApi *apiInstance = [[AdministrationApi alloc] init];

// Remove Global Moderator
[apiInstance removeGlobalModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AdministrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeGlobalModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class removeGlobalModeratorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AdministrationApi();

            try {
                // Remove Global Moderator
                oas_any_type_not_mapped result = apiInstance.removeGlobalModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationApi.removeGlobalModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationApi();

try {
    $result = $api_instance->removeGlobalModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationApi->removeGlobalModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationApi->new();

eval { 
    my $result = $api_instance->removeGlobalModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationApi->removeGlobalModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationApi()

try: 
    # Remove Global Moderator
    api_response = api_instance.remove_global_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->removeGlobalModerator: %s\n" % e)
extern crate AdministrationApi;

pub fn main() {

    let mut context = AdministrationApi::Context::default();
    let result = client.removeGlobalModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


removeModerator

Remove Moderator

TODO


/api/v2/administration/moderators/remove

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/administration/moderators/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdministrationApi;

import java.io.File;
import java.util.*;

public class AdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AdministrationApi apiInstance = new AdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#removeModerator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AdministrationApi;

public class AdministrationApiExample {
    public static void main(String[] args) {
        AdministrationApi apiInstance = new AdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeModerator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrationApi#removeModerator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AdministrationApi *apiInstance = [[AdministrationApi alloc] init];

// Remove Moderator
[apiInstance removeModeratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AdministrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeModerator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class removeModeratorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AdministrationApi();

            try {
                // Remove Moderator
                oas_any_type_not_mapped result = apiInstance.removeModerator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdministrationApi.removeModerator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdministrationApi();

try {
    $result = $api_instance->removeModerator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationApi->removeModerator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdministrationApi->new();

eval { 
    my $result = $api_instance->removeModerator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrationApi->removeModerator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AdministrationApi()

try: 
    # Remove Moderator
    api_response = api_instance.remove_moderator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->removeModerator: %s\n" % e)
extern crate AdministrationApi;

pub fn main() {

    let mut context = AdministrationApi::Context::default();
    let result = client.removeModerator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Auth

beginSpoofing

Begin Spoofing

TODO


/api/v2/auth/spoof/begin

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/auth/spoof/begin"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AuthApi apiInstance = new AuthApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.beginSpoofing();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#beginSpoofing");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthApi;

public class AuthApiExample {
    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.beginSpoofing();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#beginSpoofing");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AuthApi *apiInstance = [[AuthApi alloc] init];

// Begin Spoofing
[apiInstance beginSpoofingWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.beginSpoofing(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class beginSpoofingExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AuthApi();

            try {
                // Begin Spoofing
                oas_any_type_not_mapped result = apiInstance.beginSpoofing();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthApi.beginSpoofing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthApi();

try {
    $result = $api_instance->beginSpoofing();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->beginSpoofing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthApi->new();

eval { 
    my $result = $api_instance->beginSpoofing();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->beginSpoofing: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthApi()

try: 
    # Begin Spoofing
    api_response = api_instance.begin_spoofing()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->beginSpoofing: %s\n" % e)
extern crate AuthApi;

pub fn main() {

    let mut context = AuthApi::Context::default();
    let result = client.beginSpoofing(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


checkFor2faLogin

Check For 2FA Login

Complete the login process if a two-factor authentication token is required from the beginning of the login process.


/api/v2/auth/checkFor2faLogin

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://www.floatplane.com/api/v2/auth/checkFor2faLogin"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AuthApi apiInstance = new AuthApi();
        CheckFor2faLoginRequest checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest | 
        
        try {
            AuthLoginV2Response result = apiInstance.checkFor2faLogin(checkFor2faLoginRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#checkFor2faLogin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthApi;

public class AuthApiExample {
    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        CheckFor2faLoginRequest checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest | 
        
        try {
            AuthLoginV2Response result = apiInstance.checkFor2faLogin(checkFor2faLoginRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#checkFor2faLogin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AuthApi *apiInstance = [[AuthApi alloc] init];
CheckFor2faLoginRequest *checkFor2faLoginRequest = {"token":"123456"}; // 

// Check For 2FA Login
[apiInstance checkFor2faLoginWith:checkFor2faLoginRequest
              completionHandler: ^(AuthLoginV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AuthApi()
var checkFor2faLoginRequest = {"token":"123456"}; // {CheckFor2faLoginRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkFor2faLogin(checkFor2faLoginRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class checkFor2faLoginExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AuthApi();
            var checkFor2faLoginRequest = new CheckFor2faLoginRequest(); // CheckFor2faLoginRequest | 

            try {
                // Check For 2FA Login
                AuthLoginV2Response result = apiInstance.checkFor2faLogin(checkFor2faLoginRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthApi.checkFor2faLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthApi();
$checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest | 

try {
    $result = $api_instance->checkFor2faLogin($checkFor2faLoginRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->checkFor2faLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthApi->new();
my $checkFor2faLoginRequest = WWW::OPenAPIClient::Object::CheckFor2faLoginRequest->new(); # CheckFor2faLoginRequest | 

eval { 
    my $result = $api_instance->checkFor2faLogin(checkFor2faLoginRequest => $checkFor2faLoginRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->checkFor2faLogin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthApi()
checkFor2faLoginRequest = {"token":"123456"} # CheckFor2faLoginRequest | 

try: 
    # Check For 2FA Login
    api_response = api_instance.check_for2fa_login(checkFor2faLoginRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->checkFor2faLogin: %s\n" % e)
extern crate AuthApi;

pub fn main() {
    let checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest

    let mut context = AuthApi::Context::default();
    let result = client.checkFor2faLogin(checkFor2faLoginRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
checkFor2faLoginRequest *

Responses

Name Type Format Description
SetMinusCookie String Contains the cookie used in subsequent authenticated requests.


endSpoofing

End Spoofing

TODO


/api/v2/auth/spoof/end

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/auth/spoof/end"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AuthApi apiInstance = new AuthApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.endSpoofing();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#endSpoofing");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthApi;

public class AuthApiExample {
    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.endSpoofing();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#endSpoofing");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AuthApi *apiInstance = [[AuthApi alloc] init];

// End Spoofing
[apiInstance endSpoofingWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endSpoofing(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endSpoofingExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AuthApi();

            try {
                // End Spoofing
                oas_any_type_not_mapped result = apiInstance.endSpoofing();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthApi.endSpoofing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthApi();

try {
    $result = $api_instance->endSpoofing();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->endSpoofing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthApi->new();

eval { 
    my $result = $api_instance->endSpoofing();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->endSpoofing: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthApi()

try: 
    # End Spoofing
    api_response = api_instance.end_spoofing()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->endSpoofing: %s\n" % e)
extern crate AuthApi;

pub fn main() {

    let mut context = AuthApi::Context::default();
    let result = client.endSpoofing(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCaptchaInfo

Get Captcha Info

Gets the site keys used for Google Recaptcha V2 and V3. These are useful when providing a captcha token when logging in or signing up.


/api/v3/auth/captcha/info

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/auth/captcha/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AuthApi apiInstance = new AuthApi();
        
        try {
            GetCaptchaInfoRequest result = apiInstance.getCaptchaInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getCaptchaInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthApi;

public class AuthApiExample {
    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        
        try {
            GetCaptchaInfoRequest result = apiInstance.getCaptchaInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getCaptchaInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthApi *apiInstance = [[AuthApi alloc] init];

// Get Captcha Info
[apiInstance getCaptchaInfoWithCompletionHandler: 
              ^(GetCaptchaInfoRequest output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');

// Create an instance of the API class
var api = new FloatplaneApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaptchaInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCaptchaInfoExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AuthApi();

            try {
                // Get Captcha Info
                GetCaptchaInfoRequest result = apiInstance.getCaptchaInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthApi.getCaptchaInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthApi();

try {
    $result = $api_instance->getCaptchaInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->getCaptchaInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthApi->new();

eval { 
    my $result = $api_instance->getCaptchaInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->getCaptchaInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AuthApi()

try: 
    # Get Captcha Info
    api_response = api_instance.get_captcha_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->getCaptchaInfo: %s\n" % e)
extern crate AuthApi;

pub fn main() {

    let mut context = AuthApi::Context::default();
    let result = client.getCaptchaInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


login

Login

Login to Floatplane with the provided username and password, retrieving the authentication/authorization cookie from the response for subsequent requests.


/api/v2/auth/login

Usage and SDK Samples

curl -X POST\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://www.floatplane.com/api/v2/auth/login"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AuthApi apiInstance = new AuthApi();
        AuthLoginV2Request authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request | 
        
        try {
            AuthLoginV2Response result = apiInstance.login(authLoginV2Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#login");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthApi;

public class AuthApiExample {
    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        AuthLoginV2Request authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request | 
        
        try {
            AuthLoginV2Response result = apiInstance.login(authLoginV2Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#login");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthApi *apiInstance = [[AuthApi alloc] init];
AuthLoginV2Request *authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // 

// Login
[apiInstance loginWith:authLoginV2Request
              completionHandler: ^(AuthLoginV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');

// Create an instance of the API class
var api = new FloatplaneApi.AuthApi()
var authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // {AuthLoginV2Request} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(authLoginV2Request, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class loginExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AuthApi();
            var authLoginV2Request = new AuthLoginV2Request(); // AuthLoginV2Request | 

            try {
                // Login
                AuthLoginV2Response result = apiInstance.login(authLoginV2Request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthApi();
$authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request | 

try {
    $result = $api_instance->login($authLoginV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthApi->new();
my $authLoginV2Request = WWW::OPenAPIClient::Object::AuthLoginV2Request->new(); # AuthLoginV2Request | 

eval { 
    my $result = $api_instance->login(authLoginV2Request => $authLoginV2Request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->login: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AuthApi()
authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."} # AuthLoginV2Request | 

try: 
    # Login
    api_response = api_instance.login(authLoginV2Request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->login: %s\n" % e)
extern crate AuthApi;

pub fn main() {
    let authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request

    let mut context = AuthApi::Context::default();
    let result = client.login(authLoginV2Request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
authLoginV2Request *

Responses

Name Type Format Description
SetMinusCookie String Contains the cookie used in subsequent authenticated requests.


logout

Logout

Log out of Floatplane, invalidating the authentication/authorization cookie.


/api/v2/auth/logout

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: text/plain,application/json"\
 "https://www.floatplane.com/api/v2/auth/logout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AuthApi apiInstance = new AuthApi();
        
        try {
            'String' result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#logout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthApi;

public class AuthApiExample {
    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        
        try {
            'String' result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#logout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AuthApi *apiInstance = [[AuthApi alloc] init];

// Logout
[apiInstance logoutWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.logout(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class logoutExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AuthApi();

            try {
                // Logout
                'String' result = apiInstance.logout();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthApi();

try {
    $result = $api_instance->logout();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->logout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthApi->new();

eval { 
    my $result = $api_instance->logout();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->logout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthApi()

try: 
    # Logout
    api_response = api_instance.logout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->logout: %s\n" % e)
extern crate AuthApi;

pub fn main() {

    let mut context = AuthApi::Context::default();
    let result = client.logout(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
SetMinusCookie String Contains the cookie used in subsequent authenticated requests.


signup

Signup

TODO


/api/v2/auth/signup

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/auth/signup"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AuthApi apiInstance = new AuthApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.signup();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#signup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthApi;

public class AuthApiExample {
    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.signup();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#signup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AuthApi *apiInstance = [[AuthApi alloc] init];

// Signup
[apiInstance signupWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signup(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class signupExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AuthApi();

            try {
                // Signup
                oas_any_type_not_mapped result = apiInstance.signup();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthApi.signup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthApi();

try {
    $result = $api_instance->signup();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->signup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthApi->new();

eval { 
    my $result = $api_instance->signup();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->signup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthApi()

try: 
    # Signup
    api_response = api_instance.signup()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->signup: %s\n" % e)
extern crate AuthApi;

pub fn main() {

    let mut context = AuthApi::Context::default();
    let result = client.signup(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


BrainTree

generateClientToken

Generate Client Token

TODO


/api/v2/payment/braintree/token

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/braintree/token"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BrainTreeApi;

import java.io.File;
import java.util.*;

public class BrainTreeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        BrainTreeApi apiInstance = new BrainTreeApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.generateClientToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrainTreeApi#generateClientToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BrainTreeApi;

public class BrainTreeApiExample {
    public static void main(String[] args) {
        BrainTreeApi apiInstance = new BrainTreeApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.generateClientToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrainTreeApi#generateClientToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
BrainTreeApi *apiInstance = [[BrainTreeApi alloc] init];

// Generate Client Token
[apiInstance generateClientTokenWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.BrainTreeApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateClientToken(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class generateClientTokenExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new BrainTreeApi();

            try {
                // Generate Client Token
                oas_any_type_not_mapped result = apiInstance.generateClientToken();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BrainTreeApi.generateClientToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BrainTreeApi();

try {
    $result = $api_instance->generateClientToken();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrainTreeApi->generateClientToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BrainTreeApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BrainTreeApi->new();

eval { 
    my $result = $api_instance->generateClientToken();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrainTreeApi->generateClientToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.BrainTreeApi()

try: 
    # Generate Client Token
    api_response = api_instance.generate_client_token()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrainTreeApi->generateClientToken: %s\n" % e)
extern crate BrainTreeApi;

pub fn main() {

    let mut context = BrainTreeApi::Context::default();
    let result = client.generateClientToken(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


CDN

getDeliveryInfo

Get Delivery Info

Given an video/audio attachment identifier, retrieves the information necessary to play, download, or livestream the video/audio at various quality levels.


/api/v2/cdn/delivery

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/cdn/delivery?type=&guid="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CDNApi;

import java.io.File;
import java.util.*;

public class CDNApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CDNApi apiInstance = new CDNApi();
        String type = type_example; // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
        String guid = guid_example; // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object.
        
        try {
            CdnDeliveryV2Response result = apiInstance.getDeliveryInfo(type, guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CDNApi#getDeliveryInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CDNApi;

public class CDNApiExample {
    public static void main(String[] args) {
        CDNApi apiInstance = new CDNApi();
        String type = type_example; // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
        String guid = guid_example; // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object.
        
        try {
            CdnDeliveryV2Response result = apiInstance.getDeliveryInfo(type, guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CDNApi#getDeliveryInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CDNApi *apiInstance = [[CDNApi alloc] init];
String *type = type_example; // Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later. (default to null)
String *guid = guid_example; // The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. (default to null)

// Get Delivery Info
[apiInstance getDeliveryInfoWith:type
    guid:guid
              completionHandler: ^(CdnDeliveryV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CDNApi()
var type = type_example; // {String} Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
var guid = guid_example; // {String} The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryInfo(type, guid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeliveryInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CDNApi();
            var type = type_example;  // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later. (default to null)
            var guid = guid_example;  // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. (default to null)

            try {
                // Get Delivery Info
                CdnDeliveryV2Response result = apiInstance.getDeliveryInfo(type, guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CDNApi.getDeliveryInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CDNApi();
$type = type_example; // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
$guid = guid_example; // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object.

try {
    $result = $api_instance->getDeliveryInfo($type, $guid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CDNApi->getDeliveryInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CDNApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CDNApi->new();
my $type = type_example; # String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
my $guid = guid_example; # String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object.

eval { 
    my $result = $api_instance->getDeliveryInfo(type => $type, guid => $guid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CDNApi->getDeliveryInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CDNApi()
type = type_example # String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later. (default to null)
guid = guid_example # String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. (default to null)

try: 
    # Get Delivery Info
    api_response = api_instance.get_delivery_info(type, guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CDNApi->getDeliveryInfo: %s\n" % e)
extern crate CDNApi;

pub fn main() {
    let type = type_example; // String
    let guid = guid_example; // String

    let mut context = CDNApi::Context::default();
    let result = client.getDeliveryInfo(type, guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
type*
String
Used to determine which kind of retrieval method is requested for the video. - VOD = stream a Video On Demand - AOD = stream Audio On Demand - Live = Livestream the content - Download = Download the content for the user to play later.
Required
guid*
String
The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object.
Required

Responses


CMSBlogPost

createBlogPost

Create Blog Post

TODO


/api/cms/v3/blogPost/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/blogPost/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostApi;

import java.io.File;
import java.util.*;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#createBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostApi;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#createBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSBlogPostApi *apiInstance = [[CMSBlogPostApi alloc] init];

// Create Blog Post
[apiInstance createBlogPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSBlogPostApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBlogPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createBlogPostExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSBlogPostApi();

            try {
                // Create Blog Post
                oas_any_type_not_mapped result = apiInstance.createBlogPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostApi.createBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostApi();

try {
    $result = $api_instance->createBlogPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostApi->createBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostApi->new();

eval { 
    my $result = $api_instance->createBlogPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostApi->createBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostApi()

try: 
    # Create Blog Post
    api_response = api_instance.create_blog_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostApi->createBlogPost: %s\n" % e)
extern crate CMSBlogPostApi;

pub fn main() {

    let mut context = CMSBlogPostApi::Context::default();
    let result = client.createBlogPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


deleteBlogPost

Delete Blog Post

TODO


/api/cms/v3/blogPost/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/blogPost/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostApi;

import java.io.File;
import java.util.*;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#deleteBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostApi;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#deleteBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSBlogPostApi *apiInstance = [[CMSBlogPostApi alloc] init];

// Delete Blog Post
[apiInstance deleteBlogPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSBlogPostApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteBlogPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteBlogPostExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSBlogPostApi();

            try {
                // Delete Blog Post
                oas_any_type_not_mapped result = apiInstance.deleteBlogPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostApi.deleteBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostApi();

try {
    $result = $api_instance->deleteBlogPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostApi->deleteBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostApi->new();

eval { 
    my $result = $api_instance->deleteBlogPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostApi->deleteBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostApi()

try: 
    # Delete Blog Post
    api_response = api_instance.delete_blog_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostApi->deleteBlogPost: %s\n" % e)
extern crate CMSBlogPostApi;

pub fn main() {

    let mut context = CMSBlogPostApi::Context::default();
    let result = client.deleteBlogPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


editBlogPost

Edit Blog Post

TODO


/api/cms/v3/blogPost/edit

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/blogPost/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostApi;

import java.io.File;
import java.util.*;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.editBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#editBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostApi;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.editBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#editBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSBlogPostApi *apiInstance = [[CMSBlogPostApi alloc] init];

// Edit Blog Post
[apiInstance editBlogPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSBlogPostApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editBlogPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class editBlogPostExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSBlogPostApi();

            try {
                // Edit Blog Post
                oas_any_type_not_mapped result = apiInstance.editBlogPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostApi.editBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostApi();

try {
    $result = $api_instance->editBlogPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostApi->editBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostApi->new();

eval { 
    my $result = $api_instance->editBlogPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostApi->editBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostApi()

try: 
    # Edit Blog Post
    api_response = api_instance.edit_blog_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostApi->editBlogPost: %s\n" % e)
extern crate CMSBlogPostApi;

pub fn main() {

    let mut context = CMSBlogPostApi::Context::default();
    let result = client.editBlogPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getBlogPostCMS

Get Blog Post

TODO


/api/cms/v3/blogPost/get

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/blogPost/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostApi;

import java.io.File;
import java.util.*;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getBlogPostCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#getBlogPostCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostApi;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getBlogPostCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#getBlogPostCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSBlogPostApi *apiInstance = [[CMSBlogPostApi alloc] init];

// Get Blog Post
[apiInstance getBlogPostCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSBlogPostApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBlogPostCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBlogPostCMSExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSBlogPostApi();

            try {
                // Get Blog Post
                oas_any_type_not_mapped result = apiInstance.getBlogPostCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostApi.getBlogPostCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostApi();

try {
    $result = $api_instance->getBlogPostCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostApi->getBlogPostCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostApi->new();

eval { 
    my $result = $api_instance->getBlogPostCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostApi->getBlogPostCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostApi()

try: 
    # Get Blog Post
    api_response = api_instance.get_blog_post_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostApi->getBlogPostCMS: %s\n" % e)
extern crate CMSBlogPostApi;

pub fn main() {

    let mut context = CMSBlogPostApi::Context::default();
    let result = client.getBlogPostCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listBlogPost

List Blog Post

TODO


/api/cms/v3/blogPost/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/blogPost/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostApi;

import java.io.File;
import java.util.*;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#listBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostApi;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listBlogPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#listBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSBlogPostApi *apiInstance = [[CMSBlogPostApi alloc] init];

// List Blog Post
[apiInstance listBlogPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSBlogPostApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listBlogPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listBlogPostExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSBlogPostApi();

            try {
                // List Blog Post
                oas_any_type_not_mapped result = apiInstance.listBlogPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostApi.listBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostApi();

try {
    $result = $api_instance->listBlogPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostApi->listBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostApi->new();

eval { 
    my $result = $api_instance->listBlogPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostApi->listBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostApi()

try: 
    # List Blog Post
    api_response = api_instance.list_blog_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostApi->listBlogPost: %s\n" % e)
extern crate CMSBlogPostApi;

pub fn main() {

    let mut context = CMSBlogPostApi::Context::default();
    let result = client.listBlogPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateNewAttachments

Update New Attachments

TODO


/api/cms/v3/blogPost/attachments/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/blogPost/attachments/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSBlogPostApi;

import java.io.File;
import java.util.*;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateNewAttachments();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#updateNewAttachments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSBlogPostApi;

public class CMSBlogPostApiExample {
    public static void main(String[] args) {
        CMSBlogPostApi apiInstance = new CMSBlogPostApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateNewAttachments();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSBlogPostApi#updateNewAttachments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSBlogPostApi *apiInstance = [[CMSBlogPostApi alloc] init];

// Update New Attachments
[apiInstance updateNewAttachmentsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSBlogPostApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateNewAttachments(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateNewAttachmentsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSBlogPostApi();

            try {
                // Update New Attachments
                oas_any_type_not_mapped result = apiInstance.updateNewAttachments();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSBlogPostApi.updateNewAttachments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSBlogPostApi();

try {
    $result = $api_instance->updateNewAttachments();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSBlogPostApi->updateNewAttachments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSBlogPostApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSBlogPostApi->new();

eval { 
    my $result = $api_instance->updateNewAttachments();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSBlogPostApi->updateNewAttachments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSBlogPostApi()

try: 
    # Update New Attachments
    api_response = api_instance.update_new_attachments()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSBlogPostApi->updateNewAttachments: %s\n" % e)
extern crate CMSBlogPostApi;

pub fn main() {

    let mut context = CMSBlogPostApi::Context::default();
    let result = client.updateNewAttachments(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


CMSContent

deleteContent

Delete Content

TODO


/api/cms/v3/content/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#deleteContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#deleteContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// Delete Content
[apiInstance deleteContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // Delete Content
                oas_any_type_not_mapped result = apiInstance.deleteContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.deleteContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->deleteContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->deleteContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->deleteContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->deleteContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # Delete Content
    api_response = api_instance.delete_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->deleteContent: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.deleteContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


editContent

Edit Content

TODO


/api/cms/v3/content/edit

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.editContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#editContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.editContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#editContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// Edit Content
[apiInstance editContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class editContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // Edit Content
                oas_any_type_not_mapped result = apiInstance.editContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.editContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->editContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->editContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->editContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->editContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # Edit Content
    api_response = api_instance.edit_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->editContent: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.editContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getAudioContentCMS

Get Audio Content

TODO


/api/cms/v3/content/audio/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/audio/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAudioContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getAudioContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAudioContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getAudioContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// Get Audio Content
[apiInstance getAudioContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAudioContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAudioContentCMSExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // Get Audio Content
                oas_any_type_not_mapped result = apiInstance.getAudioContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.getAudioContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->getAudioContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->getAudioContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->getAudioContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->getAudioContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # Get Audio Content
    api_response = api_instance.get_audio_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->getAudioContentCMS: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.getAudioContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getContentCMS

Get Content

TODO


/api/cms/v3/content/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// Get Content
[apiInstance getContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getContentCMSExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // Get Content
                oas_any_type_not_mapped result = apiInstance.getContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.getContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->getContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->getContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->getContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->getContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # Get Content
    api_response = api_instance.get_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->getContentCMS: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.getContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getGalleryContentCMS

Get Gallery Content

TODO


/api/cms/v3/content/gallery/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/gallery/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getGalleryContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getGalleryContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getGalleryContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getGalleryContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// Get Gallery Content
[apiInstance getGalleryContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGalleryContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getGalleryContentCMSExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // Get Gallery Content
                oas_any_type_not_mapped result = apiInstance.getGalleryContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.getGalleryContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->getGalleryContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->getGalleryContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->getGalleryContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->getGalleryContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # Get Gallery Content
    api_response = api_instance.get_gallery_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->getGalleryContentCMS: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.getGalleryContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getPictureContentCMS

Get Picture Content

TODO


/api/cms/v3/content/picture/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/picture/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPictureContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getPictureContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPictureContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getPictureContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// Get Picture Content
[apiInstance getPictureContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPictureContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPictureContentCMSExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // Get Picture Content
                oas_any_type_not_mapped result = apiInstance.getPictureContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.getPictureContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->getPictureContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->getPictureContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->getPictureContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->getPictureContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # Get Picture Content
    api_response = api_instance.get_picture_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->getPictureContentCMS: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.getPictureContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getVideoContentCMS

Get Video Content

TODO


/api/cms/v3/content/video/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/video/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getVideoContentCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoContentCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#getVideoContentCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// Get Video Content
[apiInstance getVideoContentCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoContentCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVideoContentCMSExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // Get Video Content
                oas_any_type_not_mapped result = apiInstance.getVideoContentCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.getVideoContentCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->getVideoContentCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->getVideoContentCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->getVideoContentCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->getVideoContentCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # Get Video Content
    api_response = api_instance.get_video_content_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->getVideoContentCMS: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.getVideoContentCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listAudioContent

List Audio Content

TODO


/api/cms/v3/content/audio/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/audio/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listAudioContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#listAudioContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listAudioContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#listAudioContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// List Audio Content
[apiInstance listAudioContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAudioContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listAudioContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // List Audio Content
                oas_any_type_not_mapped result = apiInstance.listAudioContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.listAudioContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->listAudioContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->listAudioContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->listAudioContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->listAudioContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # List Audio Content
    api_response = api_instance.list_audio_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->listAudioContent: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.listAudioContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listGalleryContent

List Gallery Content

TODO


/api/cms/v3/content/gallery/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/gallery/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listGalleryContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#listGalleryContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listGalleryContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#listGalleryContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// List Gallery Content
[apiInstance listGalleryContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listGalleryContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listGalleryContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // List Gallery Content
                oas_any_type_not_mapped result = apiInstance.listGalleryContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.listGalleryContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->listGalleryContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->listGalleryContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->listGalleryContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->listGalleryContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # List Gallery Content
    api_response = api_instance.list_gallery_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->listGalleryContent: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.listGalleryContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listPictureContent

List Picture Content

TODO


/api/cms/v3/content/picture/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/picture/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listPictureContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#listPictureContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listPictureContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#listPictureContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// List Picture Content
[apiInstance listPictureContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPictureContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listPictureContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // List Picture Content
                oas_any_type_not_mapped result = apiInstance.listPictureContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.listPictureContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->listPictureContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->listPictureContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->listPictureContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->listPictureContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # List Picture Content
    api_response = api_instance.list_picture_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->listPictureContent: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.listPictureContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listVideoContent

List Video Content

TODO


/api/cms/v3/content/video/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/content/video/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSContentApi;

import java.io.File;
import java.util.*;

public class CMSContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listVideoContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#listVideoContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSContentApi;

public class CMSContentApiExample {
    public static void main(String[] args) {
        CMSContentApi apiInstance = new CMSContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listVideoContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSContentApi#listVideoContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSContentApi *apiInstance = [[CMSContentApi alloc] init];

// List Video Content
[apiInstance listVideoContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listVideoContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listVideoContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSContentApi();

            try {
                // List Video Content
                oas_any_type_not_mapped result = apiInstance.listVideoContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSContentApi.listVideoContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSContentApi();

try {
    $result = $api_instance->listVideoContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSContentApi->listVideoContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSContentApi->new();

eval { 
    my $result = $api_instance->listVideoContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSContentApi->listVideoContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSContentApi()

try: 
    # List Video Content
    api_response = api_instance.list_video_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSContentApi->listVideoContent: %s\n" % e)
extern crate CMSContentApi;

pub fn main() {

    let mut context = CMSContentApi::Context::default();
    let result = client.listVideoContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


CMSCreatorSubscriptionPlan

downloadSubscribers

Download Subscribers

TODO


/api/cms/v3/subscribers/download

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/subscribers/download"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorSubscriptionPlanApi;

import java.io.File;
import java.util.*;

public class CMSCreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorSubscriptionPlanApi apiInstance = new CMSCreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.downloadSubscribers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanApi#downloadSubscribers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorSubscriptionPlanApi;

public class CMSCreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        CMSCreatorSubscriptionPlanApi apiInstance = new CMSCreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.downloadSubscribers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanApi#downloadSubscribers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorSubscriptionPlanApi *apiInstance = [[CMSCreatorSubscriptionPlanApi alloc] init];

// Download Subscribers
[apiInstance downloadSubscribersWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorSubscriptionPlanApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadSubscribers(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class downloadSubscribersExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorSubscriptionPlanApi();

            try {
                // Download Subscribers
                oas_any_type_not_mapped result = apiInstance.downloadSubscribers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorSubscriptionPlanApi.downloadSubscribers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorSubscriptionPlanApi();

try {
    $result = $api_instance->downloadSubscribers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorSubscriptionPlanApi->downloadSubscribers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorSubscriptionPlanApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorSubscriptionPlanApi->new();

eval { 
    my $result = $api_instance->downloadSubscribers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorSubscriptionPlanApi->downloadSubscribers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorSubscriptionPlanApi()

try: 
    # Download Subscribers
    api_response = api_instance.download_subscribers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorSubscriptionPlanApi->downloadSubscribers: %s\n" % e)
extern crate CMSCreatorSubscriptionPlanApi;

pub fn main() {

    let mut context = CMSCreatorSubscriptionPlanApi::Context::default();
    let result = client.downloadSubscribers(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listSubscribers

List Subscribers

TODO


/api/cms/v3/subscribers/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/subscribers/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorSubscriptionPlanApi;

import java.io.File;
import java.util.*;

public class CMSCreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorSubscriptionPlanApi apiInstance = new CMSCreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listSubscribers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanApi#listSubscribers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorSubscriptionPlanApi;

public class CMSCreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        CMSCreatorSubscriptionPlanApi apiInstance = new CMSCreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listSubscribers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanApi#listSubscribers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorSubscriptionPlanApi *apiInstance = [[CMSCreatorSubscriptionPlanApi alloc] init];

// List Subscribers
[apiInstance listSubscribersWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorSubscriptionPlanApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubscribers(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listSubscribersExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorSubscriptionPlanApi();

            try {
                // List Subscribers
                oas_any_type_not_mapped result = apiInstance.listSubscribers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorSubscriptionPlanApi.listSubscribers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorSubscriptionPlanApi();

try {
    $result = $api_instance->listSubscribers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorSubscriptionPlanApi->listSubscribers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorSubscriptionPlanApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorSubscriptionPlanApi->new();

eval { 
    my $result = $api_instance->listSubscribers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorSubscriptionPlanApi->listSubscribers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorSubscriptionPlanApi()

try: 
    # List Subscribers
    api_response = api_instance.list_subscribers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorSubscriptionPlanApi->listSubscribers: %s\n" % e)
extern crate CMSCreatorSubscriptionPlanApi;

pub fn main() {

    let mut context = CMSCreatorSubscriptionPlanApi::Context::default();
    let result = client.listSubscribers(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listSubscriptionPlansCMS

List Subscription Plans

TODO


/api/cms/v3/plan/list

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/plan/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorSubscriptionPlanApi;

import java.io.File;
import java.util.*;

public class CMSCreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorSubscriptionPlanApi apiInstance = new CMSCreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listSubscriptionPlansCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanApi#listSubscriptionPlansCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorSubscriptionPlanApi;

public class CMSCreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        CMSCreatorSubscriptionPlanApi apiInstance = new CMSCreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listSubscriptionPlansCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorSubscriptionPlanApi#listSubscriptionPlansCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorSubscriptionPlanApi *apiInstance = [[CMSCreatorSubscriptionPlanApi alloc] init];

// List Subscription Plans
[apiInstance listSubscriptionPlansCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorSubscriptionPlanApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubscriptionPlansCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listSubscriptionPlansCMSExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorSubscriptionPlanApi();

            try {
                // List Subscription Plans
                oas_any_type_not_mapped result = apiInstance.listSubscriptionPlansCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorSubscriptionPlanApi.listSubscriptionPlansCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorSubscriptionPlanApi();

try {
    $result = $api_instance->listSubscriptionPlansCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorSubscriptionPlanApi->listSubscriptionPlansCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorSubscriptionPlanApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorSubscriptionPlanApi->new();

eval { 
    my $result = $api_instance->listSubscriptionPlansCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorSubscriptionPlanApi->listSubscriptionPlansCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorSubscriptionPlanApi()

try: 
    # List Subscription Plans
    api_response = api_instance.list_subscription_plans_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorSubscriptionPlanApi->listSubscriptionPlansCMS: %s\n" % e)
extern crate CMSCreatorSubscriptionPlanApi;

pub fn main() {

    let mut context = CMSCreatorSubscriptionPlanApi::Context::default();
    let result = client.listSubscriptionPlansCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


CMSCreatorWarehouse

createPriceRule

Create Price Rule

TODO


/api/cms/v3/creatorwarehouse/pricerule/create

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/create"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#createPriceRule");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#createPriceRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Create Price Rule
[apiInstance createPriceRuleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPriceRule(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createPriceRuleExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Create Price Rule
                oas_any_type_not_mapped result = apiInstance.createPriceRule();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.createPriceRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->createPriceRule();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->createPriceRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->createPriceRule();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->createPriceRule: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Create Price Rule
    api_response = api_instance.create_price_rule()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->createPriceRule: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.createPriceRule(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


deletePriceRule

Delete Price Rule

TODO


/api/cms/v3/creatorwarehouse/pricerule/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deletePriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#deletePriceRule");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deletePriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#deletePriceRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Delete Price Rule
[apiInstance deletePriceRuleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePriceRule(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deletePriceRuleExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Delete Price Rule
                oas_any_type_not_mapped result = apiInstance.deletePriceRule();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.deletePriceRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->deletePriceRule();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->deletePriceRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->deletePriceRule();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->deletePriceRule: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Delete Price Rule
    api_response = api_instance.delete_price_rule()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->deletePriceRule: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.deletePriceRule(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


editPriceRule

Edit Price Rule

TODO


/api/cms/v3/creatorwarehouse/pricerule/edit

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/edit"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.editPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#editPriceRule");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.editPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#editPriceRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Edit Price Rule
[apiInstance editPriceRuleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editPriceRule(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class editPriceRuleExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Edit Price Rule
                oas_any_type_not_mapped result = apiInstance.editPriceRule();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.editPriceRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->editPriceRule();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->editPriceRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->editPriceRule();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->editPriceRule: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Edit Price Rule
    api_response = api_instance.edit_price_rule()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->editPriceRule: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.editPriceRule(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCollections

Get Collections

TODO


/api/cms/v3/creatorwarehouse/collections/get

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/collections/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCollections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getCollections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCollections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getCollections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Get Collections
[apiInstance getCollectionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCollections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCollectionsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Get Collections
                oas_any_type_not_mapped result = apiInstance.getCollections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.getCollections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->getCollections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->getCollections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->getCollections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->getCollections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Get Collections
    api_response = api_instance.get_collections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->getCollections: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.getCollections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCountries

Get Countries

TODO


/api/cms/v3/creatorwarehouse/countries/get

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/countries/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getCountries");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getCountries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Get Countries
[apiInstance getCountriesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCountries(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCountriesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Get Countries
                oas_any_type_not_mapped result = apiInstance.getCountries();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.getCountries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->getCountries();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->getCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->getCountries();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->getCountries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Get Countries
    api_response = api_instance.get_countries()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->getCountries: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.getCountries(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreatorWarehouse

Get Creator Warehouse

TODO


/api/cms/v3/creatorwarehouse

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorWarehouse();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getCreatorWarehouse");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorWarehouse();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getCreatorWarehouse");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Get Creator Warehouse
[apiInstance getCreatorWarehouseWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorWarehouse(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorWarehouseExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Get Creator Warehouse
                oas_any_type_not_mapped result = apiInstance.getCreatorWarehouse();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.getCreatorWarehouse: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->getCreatorWarehouse();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->getCreatorWarehouse: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->getCreatorWarehouse();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->getCreatorWarehouse: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Get Creator Warehouse
    api_response = api_instance.get_creator_warehouse()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->getCreatorWarehouse: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.getCreatorWarehouse(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getPriceRule

Get Price Rule

TODO


/api/cms/v3/creatorwarehouse/pricerule/

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getPriceRule");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPriceRule();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getPriceRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Get Price Rule
[apiInstance getPriceRuleWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPriceRule(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPriceRuleExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Get Price Rule
                oas_any_type_not_mapped result = apiInstance.getPriceRule();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.getPriceRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->getPriceRule();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->getPriceRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->getPriceRule();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->getPriceRule: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Get Price Rule
    api_response = api_instance.get_price_rule()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->getPriceRule: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.getPriceRule(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getProducts

Get Products

TODO


/api/cms/v3/creatorwarehouse/products/get

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/products/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getProducts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Get Products
[apiInstance getProductsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducts(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProductsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Get Products
                oas_any_type_not_mapped result = apiInstance.getProducts();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.getProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->getProducts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->getProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->getProducts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->getProducts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Get Products
    api_response = api_instance.get_products()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->getProducts: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.getProducts(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getShopInfo

Get Shop Info

TODO


/api/cms/v3/creatorwarehouse/shop/get

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/shop/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getShopInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getShopInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getShopInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#getShopInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Get Shop Info
[apiInstance getShopInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShopInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getShopInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Get Shop Info
                oas_any_type_not_mapped result = apiInstance.getShopInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.getShopInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->getShopInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->getShopInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->getShopInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->getShopInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Get Shop Info
    api_response = api_instance.get_shop_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->getShopInfo: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.getShopInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listCollections

List Collections

TODO


/api/cms/v3/creatorwarehouse/collections/list

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/collections/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCollections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#listCollections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCollections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#listCollections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// List Collections
[apiInstance listCollectionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCollections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCollectionsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // List Collections
                oas_any_type_not_mapped result = apiInstance.listCollections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.listCollections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->listCollections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->listCollections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->listCollections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->listCollections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # List Collections
    api_response = api_instance.list_collections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->listCollections: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.listCollections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listPriceRules

List Price Rules

TODO


/api/cms/v3/creatorwarehouse/pricerule/list

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/pricerule/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listPriceRules();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#listPriceRules");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listPriceRules();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#listPriceRules");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// List Price Rules
[apiInstance listPriceRulesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPriceRules(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listPriceRulesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // List Price Rules
                oas_any_type_not_mapped result = apiInstance.listPriceRules();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.listPriceRules: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->listPriceRules();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->listPriceRules: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->listPriceRules();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->listPriceRules: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # List Price Rules
    api_response = api_instance.list_price_rules()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->listPriceRules: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.listPriceRules(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listProducts

List Products

TODO


/api/cms/v3/creatorwarehouse/products/list

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/products/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#listProducts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#listProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// List Products
[apiInstance listProductsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProducts(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listProductsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // List Products
                oas_any_type_not_mapped result = apiInstance.listProducts();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.listProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->listProducts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->listProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->listProducts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->listProducts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # List Products
    api_response = api_instance.list_products()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->listProducts: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.listProducts(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listShopShippingCountries

List Shop Shipping Countries

TODO


/api/cms/v3/creatorwarehouse/shop/shippingcountries/list

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/shop/shippingcountries/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listShopShippingCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#listShopShippingCountries");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listShopShippingCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#listShopShippingCountries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// List Shop Shipping Countries
[apiInstance listShopShippingCountriesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listShopShippingCountries(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listShopShippingCountriesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // List Shop Shipping Countries
                oas_any_type_not_mapped result = apiInstance.listShopShippingCountries();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.listShopShippingCountries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->listShopShippingCountries();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->listShopShippingCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->listShopShippingCountries();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->listShopShippingCountries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # List Shop Shipping Countries
    api_response = api_instance.list_shop_shipping_countries()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->listShopShippingCountries: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.listShopShippingCountries(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


saveCreatorWarehouse

Save Creator Warehouse

TODO


/api/cms/v3/creatorwarehouse/save

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/creatorwarehouse/save"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSCreatorWarehouseApi;

import java.io.File;
import java.util.*;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveCreatorWarehouse();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#saveCreatorWarehouse");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSCreatorWarehouseApi;

public class CMSCreatorWarehouseApiExample {
    public static void main(String[] args) {
        CMSCreatorWarehouseApi apiInstance = new CMSCreatorWarehouseApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.saveCreatorWarehouse();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSCreatorWarehouseApi#saveCreatorWarehouse");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSCreatorWarehouseApi *apiInstance = [[CMSCreatorWarehouseApi alloc] init];

// Save Creator Warehouse
[apiInstance saveCreatorWarehouseWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSCreatorWarehouseApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveCreatorWarehouse(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class saveCreatorWarehouseExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSCreatorWarehouseApi();

            try {
                // Save Creator Warehouse
                oas_any_type_not_mapped result = apiInstance.saveCreatorWarehouse();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSCreatorWarehouseApi.saveCreatorWarehouse: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSCreatorWarehouseApi();

try {
    $result = $api_instance->saveCreatorWarehouse();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSCreatorWarehouseApi->saveCreatorWarehouse: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSCreatorWarehouseApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSCreatorWarehouseApi->new();

eval { 
    my $result = $api_instance->saveCreatorWarehouse();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSCreatorWarehouseApi->saveCreatorWarehouse: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSCreatorWarehouseApi()

try: 
    # Save Creator Warehouse
    api_response = api_instance.save_creator_warehouse()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSCreatorWarehouseApi->saveCreatorWarehouse: %s\n" % e)
extern crate CMSCreatorWarehouseApi;

pub fn main() {

    let mut context = CMSCreatorWarehouseApi::Context::default();
    let result = client.saveCreatorWarehouse(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


CMSLivestream

getLivestreamInfo

Get Livestream Info

TODO


/api/cms/v3/live/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/live/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CMSLivestreamApi;

import java.io.File;
import java.util.*;

public class CMSLivestreamApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CMSLivestreamApi apiInstance = new CMSLivestreamApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getLivestreamInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSLivestreamApi#getLivestreamInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CMSLivestreamApi;

public class CMSLivestreamApiExample {
    public static void main(String[] args) {
        CMSLivestreamApi apiInstance = new CMSLivestreamApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getLivestreamInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSLivestreamApi#getLivestreamInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CMSLivestreamApi *apiInstance = [[CMSLivestreamApi alloc] init];

// Get Livestream Info
[apiInstance getLivestreamInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CMSLivestreamApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLivestreamInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getLivestreamInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CMSLivestreamApi();

            try {
                // Get Livestream Info
                oas_any_type_not_mapped result = apiInstance.getLivestreamInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CMSLivestreamApi.getLivestreamInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CMSLivestreamApi();

try {
    $result = $api_instance->getLivestreamInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMSLivestreamApi->getLivestreamInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CMSLivestreamApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CMSLivestreamApi->new();

eval { 
    my $result = $api_instance->getLivestreamInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMSLivestreamApi->getLivestreamInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CMSLivestreamApi()

try: 
    # Get Livestream Info
    api_response = api_instance.get_livestream_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMSLivestreamApi->getLivestreamInfo: %s\n" % e)
extern crate CMSLivestreamApi;

pub fn main() {

    let mut context = CMSLivestreamApi::Context::default();
    let result = client.getLivestreamInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Comment

dislikeComment

Dislike Comment

Dislike a comment on a blog post.


/api/v3/comment/dislike

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: text/plain,application/json"\
 -H "Content-Type: application/json"\
 "https://www.floatplane.com/api/v3/comment/dislike"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentApi;

import java.io.File;
import java.util.*;

public class CommentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CommentApi apiInstance = new CommentApi();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 
        
        try {
            'String' result = apiInstance.dislikeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#dislikeComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentApi;

public class CommentApiExample {
    public static void main(String[] args) {
        CommentApi apiInstance = new CommentApi();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 
        
        try {
            'String' result = apiInstance.dislikeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#dislikeComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentApi *apiInstance = [[CommentApi alloc] init];
CommentLikeV3PostRequest *commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // 

// Dislike Comment
[apiInstance dislikeCommentWith:commentLikeV3PostRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CommentApi()
var commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // {CommentLikeV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dislikeComment(commentLikeV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dislikeCommentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CommentApi();
            var commentLikeV3PostRequest = new CommentLikeV3PostRequest(); // CommentLikeV3PostRequest | 

            try {
                // Dislike Comment
                'String' result = apiInstance.dislikeComment(commentLikeV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentApi.dislikeComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentApi();
$commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

try {
    $result = $api_instance->dislikeComment($commentLikeV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentApi->dislikeComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentApi->new();
my $commentLikeV3PostRequest = WWW::OPenAPIClient::Object::CommentLikeV3PostRequest->new(); # CommentLikeV3PostRequest | 

eval { 
    my $result = $api_instance->dislikeComment(commentLikeV3PostRequest => $commentLikeV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentApi->dislikeComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentApi()
commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"} # CommentLikeV3PostRequest | 

try: 
    # Dislike Comment
    api_response = api_instance.dislike_comment(commentLikeV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentApi->dislikeComment: %s\n" % e)
extern crate CommentApi;

pub fn main() {
    let commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest

    let mut context = CommentApi::Context::default();
    let result = client.dislikeComment(commentLikeV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentLikeV3PostRequest *

Responses


getCommentReplies

Get Comment Replies

Retrieve more replies from a comment.


/api/v3/comment/replies

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/comment/replies?comment=&blogPost=&limit=&rid="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentApi;

import java.io.File;
import java.util.*;

public class CommentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CommentApi apiInstance = new CommentApi();
        String comment = comment_example; // String | The identifer of the comment from which to retrieve replies.
        String blogPost = blogPost_example; // String | The identifer of the blog post the `comment` belongs to.
        Integer limit = 56; // Integer | How many replies to retrieve.
        String rid = rid_example; // String | The identifer of the last reply in the reply chain.
        
        try {
            array[CommentReplyModel] result = apiInstance.getCommentReplies(comment, blogPost, limit, rid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#getCommentReplies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentApi;

public class CommentApiExample {
    public static void main(String[] args) {
        CommentApi apiInstance = new CommentApi();
        String comment = comment_example; // String | The identifer of the comment from which to retrieve replies.
        String blogPost = blogPost_example; // String | The identifer of the blog post the `comment` belongs to.
        Integer limit = 56; // Integer | How many replies to retrieve.
        String rid = rid_example; // String | The identifer of the last reply in the reply chain.
        
        try {
            array[CommentReplyModel] result = apiInstance.getCommentReplies(comment, blogPost, limit, rid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#getCommentReplies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentApi *apiInstance = [[CommentApi alloc] init];
String *comment = comment_example; // The identifer of the comment from which to retrieve replies. (default to null)
String *blogPost = blogPost_example; // The identifer of the blog post the `comment` belongs to. (default to null)
Integer *limit = 56; // How many replies to retrieve. (default to null)
String *rid = rid_example; // The identifer of the last reply in the reply chain. (default to null)

// Get Comment Replies
[apiInstance getCommentRepliesWith:comment
    blogPost:blogPost
    limit:limit
    rid:rid
              completionHandler: ^(array[CommentReplyModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CommentApi()
var comment = comment_example; // {String} The identifer of the comment from which to retrieve replies.
var blogPost = blogPost_example; // {String} The identifer of the blog post the `comment` belongs to.
var limit = 56; // {Integer} How many replies to retrieve.
var rid = rid_example; // {String} The identifer of the last reply in the reply chain.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCommentReplies(comment, blogPost, limit, rid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCommentRepliesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CommentApi();
            var comment = comment_example;  // String | The identifer of the comment from which to retrieve replies. (default to null)
            var blogPost = blogPost_example;  // String | The identifer of the blog post the `comment` belongs to. (default to null)
            var limit = 56;  // Integer | How many replies to retrieve. (default to null)
            var rid = rid_example;  // String | The identifer of the last reply in the reply chain. (default to null)

            try {
                // Get Comment Replies
                array[CommentReplyModel] result = apiInstance.getCommentReplies(comment, blogPost, limit, rid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentApi.getCommentReplies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentApi();
$comment = comment_example; // String | The identifer of the comment from which to retrieve replies.
$blogPost = blogPost_example; // String | The identifer of the blog post the `comment` belongs to.
$limit = 56; // Integer | How many replies to retrieve.
$rid = rid_example; // String | The identifer of the last reply in the reply chain.

try {
    $result = $api_instance->getCommentReplies($comment, $blogPost, $limit, $rid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentApi->getCommentReplies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentApi->new();
my $comment = comment_example; # String | The identifer of the comment from which to retrieve replies.
my $blogPost = blogPost_example; # String | The identifer of the blog post the `comment` belongs to.
my $limit = 56; # Integer | How many replies to retrieve.
my $rid = rid_example; # String | The identifer of the last reply in the reply chain.

eval { 
    my $result = $api_instance->getCommentReplies(comment => $comment, blogPost => $blogPost, limit => $limit, rid => $rid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentApi->getCommentReplies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentApi()
comment = comment_example # String | The identifer of the comment from which to retrieve replies. (default to null)
blogPost = blogPost_example # String | The identifer of the blog post the `comment` belongs to. (default to null)
limit = 56 # Integer | How many replies to retrieve. (default to null)
rid = rid_example # String | The identifer of the last reply in the reply chain. (default to null)

try: 
    # Get Comment Replies
    api_response = api_instance.get_comment_replies(comment, blogPost, limit, rid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentApi->getCommentReplies: %s\n" % e)
extern crate CommentApi;

pub fn main() {
    let comment = comment_example; // String
    let blogPost = blogPost_example; // String
    let limit = 56; // Integer
    let rid = rid_example; // String

    let mut context = CommentApi::Context::default();
    let result = client.getCommentReplies(comment, blogPost, limit, rid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
comment*
String
The identifer of the comment from which to retrieve replies.
Required
blogPost*
String
The identifer of the blog post the `comment` belongs to.
Required
limit*
Integer
How many replies to retrieve.
Required
rid*
String
The identifer of the last reply in the reply chain.
Required

Responses


getComments

Get Comments

Get comments for a blog post object. Note that replies to each comment tend to be limited to 3. The extra replies can be retrieved via `getCommentReplies`. The difference in `$response.body#/0/totalReplies` and `$response.body#/0/replies`'s length can determine if more comments need to be loaded.


/api/v3/comment

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/comment?blogPost=&limit=&fetchAfter="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentApi;

import java.io.File;
import java.util.*;

public class CommentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CommentApi apiInstance = new CommentApi();
        String blogPost = blogPost_example; // String | Which blog post to retrieve comments for.
        Integer limit = 56; // Integer | The maximum number of comments to return. This should be set to 20 by default.
        String fetchAfter = fetchAfter_example; // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.
        
        try {
            array[CommentModel] result = apiInstance.getComments(blogPost, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#getComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentApi;

public class CommentApiExample {
    public static void main(String[] args) {
        CommentApi apiInstance = new CommentApi();
        String blogPost = blogPost_example; // String | Which blog post to retrieve comments for.
        Integer limit = 56; // Integer | The maximum number of comments to return. This should be set to 20 by default.
        String fetchAfter = fetchAfter_example; // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.
        
        try {
            array[CommentModel] result = apiInstance.getComments(blogPost, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#getComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentApi *apiInstance = [[CommentApi alloc] init];
String *blogPost = blogPost_example; // Which blog post to retrieve comments for. (default to null)
Integer *limit = 56; // The maximum number of comments to return. This should be set to 20 by default. (default to null)
String *fetchAfter = fetchAfter_example; // When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`. (optional) (default to null)

// Get Comments
[apiInstance getCommentsWith:blogPost
    limit:limit
    fetchAfter:fetchAfter
              completionHandler: ^(array[CommentModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CommentApi()
var blogPost = blogPost_example; // {String} Which blog post to retrieve comments for.
var limit = 56; // {Integer} The maximum number of comments to return. This should be set to 20 by default.
var opts = {
  'fetchAfter': fetchAfter_example // {String} When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getComments(blogPost, limit, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCommentsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CommentApi();
            var blogPost = blogPost_example;  // String | Which blog post to retrieve comments for. (default to null)
            var limit = 56;  // Integer | The maximum number of comments to return. This should be set to 20 by default. (default to null)
            var fetchAfter = fetchAfter_example;  // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`. (optional)  (default to null)

            try {
                // Get Comments
                array[CommentModel] result = apiInstance.getComments(blogPost, limit, fetchAfter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentApi.getComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentApi();
$blogPost = blogPost_example; // String | Which blog post to retrieve comments for.
$limit = 56; // Integer | The maximum number of comments to return. This should be set to 20 by default.
$fetchAfter = fetchAfter_example; // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

try {
    $result = $api_instance->getComments($blogPost, $limit, $fetchAfter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentApi->getComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentApi->new();
my $blogPost = blogPost_example; # String | Which blog post to retrieve comments for.
my $limit = 56; # Integer | The maximum number of comments to return. This should be set to 20 by default.
my $fetchAfter = fetchAfter_example; # String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

eval { 
    my $result = $api_instance->getComments(blogPost => $blogPost, limit => $limit, fetchAfter => $fetchAfter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentApi->getComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentApi()
blogPost = blogPost_example # String | Which blog post to retrieve comments for. (default to null)
limit = 56 # Integer | The maximum number of comments to return. This should be set to 20 by default. (default to null)
fetchAfter = fetchAfter_example # String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`. (optional) (default to null)

try: 
    # Get Comments
    api_response = api_instance.get_comments(blogPost, limit, fetchAfter=fetchAfter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentApi->getComments: %s\n" % e)
extern crate CommentApi;

pub fn main() {
    let blogPost = blogPost_example; // String
    let limit = 56; // Integer
    let fetchAfter = fetchAfter_example; // String

    let mut context = CommentApi::Context::default();
    let result = client.getComments(blogPost, limit, fetchAfter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
blogPost*
String
Which blog post to retrieve comments for.
Required
limit*
Integer
The maximum number of comments to return. This should be set to 20 by default.
Required
fetchAfter
String
When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

Responses


likeComment

Like Comment

Like a comment on a blog post.


/api/v3/comment/like

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: text/plain,application/json"\
 -H "Content-Type: application/json"\
 "https://www.floatplane.com/api/v3/comment/like"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentApi;

import java.io.File;
import java.util.*;

public class CommentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CommentApi apiInstance = new CommentApi();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 
        
        try {
            'String' result = apiInstance.likeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#likeComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentApi;

public class CommentApiExample {
    public static void main(String[] args) {
        CommentApi apiInstance = new CommentApi();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 
        
        try {
            'String' result = apiInstance.likeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#likeComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentApi *apiInstance = [[CommentApi alloc] init];
CommentLikeV3PostRequest *commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // 

// Like Comment
[apiInstance likeCommentWith:commentLikeV3PostRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CommentApi()
var commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // {CommentLikeV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.likeComment(commentLikeV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class likeCommentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CommentApi();
            var commentLikeV3PostRequest = new CommentLikeV3PostRequest(); // CommentLikeV3PostRequest | 

            try {
                // Like Comment
                'String' result = apiInstance.likeComment(commentLikeV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentApi.likeComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentApi();
$commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

try {
    $result = $api_instance->likeComment($commentLikeV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentApi->likeComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentApi->new();
my $commentLikeV3PostRequest = WWW::OPenAPIClient::Object::CommentLikeV3PostRequest->new(); # CommentLikeV3PostRequest | 

eval { 
    my $result = $api_instance->likeComment(commentLikeV3PostRequest => $commentLikeV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentApi->likeComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentApi()
commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"} # CommentLikeV3PostRequest | 

try: 
    # Like Comment
    api_response = api_instance.like_comment(commentLikeV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentApi->likeComment: %s\n" % e)
extern crate CommentApi;

pub fn main() {
    let commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest

    let mut context = CommentApi::Context::default();
    let result = client.likeComment(commentLikeV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentLikeV3PostRequest *

Responses


postComment

Post Comment

Post a new comment to a blog post object.


/api/v3/comment

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://www.floatplane.com/api/v3/comment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentApi;

import java.io.File;
import java.util.*;

public class CommentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CommentApi apiInstance = new CommentApi();
        CommentV3PostRequest commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest | 
        
        try {
            CommentV3PostResponse result = apiInstance.postComment(commentV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#postComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentApi;

public class CommentApiExample {
    public static void main(String[] args) {
        CommentApi apiInstance = new CommentApi();
        CommentV3PostRequest commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest | 
        
        try {
            CommentV3PostResponse result = apiInstance.postComment(commentV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#postComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentApi *apiInstance = [[CommentApi alloc] init];
CommentV3PostRequest *commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // 

// Post Comment
[apiInstance postCommentWith:commentV3PostRequest
              completionHandler: ^(CommentV3PostResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CommentApi()
var commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // {CommentV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postComment(commentV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postCommentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CommentApi();
            var commentV3PostRequest = new CommentV3PostRequest(); // CommentV3PostRequest | 

            try {
                // Post Comment
                CommentV3PostResponse result = apiInstance.postComment(commentV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentApi.postComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentApi();
$commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest | 

try {
    $result = $api_instance->postComment($commentV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentApi->postComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentApi->new();
my $commentV3PostRequest = WWW::OPenAPIClient::Object::CommentV3PostRequest->new(); # CommentV3PostRequest | 

eval { 
    my $result = $api_instance->postComment(commentV3PostRequest => $commentV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentApi->postComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentApi()
commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"} # CommentV3PostRequest | 

try: 
    # Post Comment
    api_response = api_instance.post_comment(commentV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentApi->postComment: %s\n" % e)
extern crate CommentApi;

pub fn main() {
    let commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest

    let mut context = CommentApi::Context::default();
    let result = client.postComment(commentV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentV3PostRequest *

Responses


ConnectedAccounts

callback

Callback

TODO


/api/v2/connect/{site}/callback

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/connect/{site}/callback"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsApi;

import java.io.File;
import java.util.*;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        String site = site_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.callback(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#callback");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsApi;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        String site = site_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.callback(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#callback");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ConnectedAccountsApi *apiInstance = [[ConnectedAccountsApi alloc] init];
String *site = site_example; //  (default to null)

// Callback
[apiInstance callbackWith:site
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ConnectedAccountsApi()
var site = site_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.callback(site, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class callbackExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsApi();
            var site = site_example;  // String |  (default to null)

            try {
                // Callback
                oas_any_type_not_mapped result = apiInstance.callback(site);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsApi.callback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsApi();
$site = site_example; // String | 

try {
    $result = $api_instance->callback($site);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsApi->callback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsApi->new();
my $site = site_example; # String | 

eval { 
    my $result = $api_instance->callback(site => $site);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsApi->callback: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsApi()
site = site_example # String |  (default to null)

try: 
    # Callback
    api_response = api_instance.callback(site)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsApi->callback: %s\n" % e)
extern crate ConnectedAccountsApi;

pub fn main() {
    let site = site_example; // String

    let mut context = ConnectedAccountsApi::Context::default();
    let result = client.callback(site, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
site*
String
Required

Responses


complete

Complete

TODO


/api/v2/connect/complete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/connect/complete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsApi;

import java.io.File;
import java.util.*;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.complete();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#complete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsApi;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.complete();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#complete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ConnectedAccountsApi *apiInstance = [[ConnectedAccountsApi alloc] init];

// Complete
[apiInstance completeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ConnectedAccountsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.complete(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class completeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsApi();

            try {
                // Complete
                oas_any_type_not_mapped result = apiInstance.complete();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsApi.complete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsApi();

try {
    $result = $api_instance->complete();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsApi->complete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsApi->new();

eval { 
    my $result = $api_instance->complete();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsApi->complete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsApi()

try: 
    # Complete
    api_response = api_instance.complete()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsApi->complete: %s\n" % e)
extern crate ConnectedAccountsApi;

pub fn main() {

    let mut context = ConnectedAccountsApi::Context::default();
    let result = client.complete(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


dissociate

Dissociate

TODO


/api/v2/connect/dissociate

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/connect/dissociate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsApi;

import java.io.File;
import java.util.*;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.dissociate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#dissociate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsApi;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.dissociate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#dissociate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ConnectedAccountsApi *apiInstance = [[ConnectedAccountsApi alloc] init];

// Dissociate
[apiInstance dissociateWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ConnectedAccountsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dissociate(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dissociateExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsApi();

            try {
                // Dissociate
                oas_any_type_not_mapped result = apiInstance.dissociate();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsApi.dissociate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsApi();

try {
    $result = $api_instance->dissociate();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsApi->dissociate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsApi->new();

eval { 
    my $result = $api_instance->dissociate();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsApi->dissociate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsApi()

try: 
    # Dissociate
    api_response = api_instance.dissociate()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsApi->dissociate: %s\n" % e)
extern crate ConnectedAccountsApi;

pub fn main() {

    let mut context = ConnectedAccountsApi::Context::default();
    let result = client.dissociate(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getAccountConnect

Connect

TODO


/api/v2/connect/{site}

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/connect/{site}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsApi;

import java.io.File;
import java.util.*;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        String site = site_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAccountConnect(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#getAccountConnect");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsApi;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        String site = site_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAccountConnect(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#getAccountConnect");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ConnectedAccountsApi *apiInstance = [[ConnectedAccountsApi alloc] init];
String *site = site_example; //  (default to null)

// Connect
[apiInstance getAccountConnectWith:site
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ConnectedAccountsApi()
var site = site_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountConnect(site, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAccountConnectExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsApi();
            var site = site_example;  // String |  (default to null)

            try {
                // Connect
                oas_any_type_not_mapped result = apiInstance.getAccountConnect(site);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsApi.getAccountConnect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsApi();
$site = site_example; // String | 

try {
    $result = $api_instance->getAccountConnect($site);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsApi->getAccountConnect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsApi->new();
my $site = site_example; # String | 

eval { 
    my $result = $api_instance->getAccountConnect(site => $site);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsApi->getAccountConnect: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsApi()
site = site_example # String |  (default to null)

try: 
    # Connect
    api_response = api_instance.get_account_connect(site)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsApi->getAccountConnect: %s\n" % e)
extern crate ConnectedAccountsApi;

pub fn main() {
    let site = site_example; // String

    let mut context = ConnectedAccountsApi::Context::default();
    let result = client.getAccountConnect(site, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
site*
String
Required

Responses


listConnections

List Connections

List the available 3rd party accounts for the user's profile.


/api/v2/connect/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/connect/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsApi;

import java.io.File;
import java.util.*;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        
        try {
            array[ConnectedAccountModel] result = apiInstance.listConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#listConnections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsApi;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        
        try {
            array[ConnectedAccountModel] result = apiInstance.listConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#listConnections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ConnectedAccountsApi *apiInstance = [[ConnectedAccountsApi alloc] init];

// List Connections
[apiInstance listConnectionsWithCompletionHandler: 
              ^(array[ConnectedAccountModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ConnectedAccountsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listConnections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listConnectionsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsApi();

            try {
                // List Connections
                array[ConnectedAccountModel] result = apiInstance.listConnections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsApi.listConnections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsApi();

try {
    $result = $api_instance->listConnections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsApi->listConnections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsApi->new();

eval { 
    my $result = $api_instance->listConnections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsApi->listConnections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsApi()

try: 
    # List Connections
    api_response = api_instance.list_connections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsApi->listConnections: %s\n" % e)
extern crate ConnectedAccountsApi;

pub fn main() {

    let mut context = ConnectedAccountsApi::Context::default();
    let result = client.listConnections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


refresh

Refresh

TODO


/api/v2/connect/refresh

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/connect/refresh"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsApi;

import java.io.File;
import java.util.*;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.refresh();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#refresh");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsApi;

public class ConnectedAccountsApiExample {
    public static void main(String[] args) {
        ConnectedAccountsApi apiInstance = new ConnectedAccountsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.refresh();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsApi#refresh");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ConnectedAccountsApi *apiInstance = [[ConnectedAccountsApi alloc] init];

// Refresh
[apiInstance refreshWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ConnectedAccountsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refresh(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class refreshExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsApi();

            try {
                // Refresh
                oas_any_type_not_mapped result = apiInstance.refresh();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsApi.refresh: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsApi();

try {
    $result = $api_instance->refresh();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsApi->refresh: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsApi->new();

eval { 
    my $result = $api_instance->refresh();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsApi->refresh: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsApi()

try: 
    # Refresh
    api_response = api_instance.refresh()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsApi->refresh: %s\n" % e)
extern crate ConnectedAccountsApi;

pub fn main() {

    let mut context = ConnectedAccountsApi::Context::default();
    let result = client.refresh(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Content

dislikeContent

Dislike Content

TODO


/api/v3/content/dislike

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/dislike"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.dislikeContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#dislikeContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.dislikeContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#dislikeContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];

// Dislike Content
[apiInstance dislikeContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dislikeContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dislikeContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();

            try {
                // Dislike Content
                oas_any_type_not_mapped result = apiInstance.dislikeContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.dislikeContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();

try {
    $result = $api_instance->dislikeContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->dislikeContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();

eval { 
    my $result = $api_instance->dislikeContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->dislikeContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()

try: 
    # Dislike Content
    api_response = api_instance.dislike_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->dislikeContent: %s\n" % e)
extern crate ContentApi;

pub fn main() {

    let mut context = ContentApi::Context::default();
    let result = client.dislikeContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getAudioContent

Get Audio Content

TODO


/api/v3/content/audio

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/audio"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAudioContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getAudioContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAudioContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getAudioContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];

// Get Audio Content
[apiInstance getAudioContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAudioContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAudioContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();

            try {
                // Get Audio Content
                oas_any_type_not_mapped result = apiInstance.getAudioContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getAudioContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();

try {
    $result = $api_instance->getAudioContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getAudioContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();

eval { 
    my $result = $api_instance->getAudioContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getAudioContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()

try: 
    # Get Audio Content
    api_response = api_instance.get_audio_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getAudioContent: %s\n" % e)
extern crate ContentApi;

pub fn main() {

    let mut context = ContentApi::Context::default();
    let result = client.getAudioContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getBlogPost

Get Blog Post

Retrieve more details on a specific blog post object for viewing.


/api/v3/content/post

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/post?id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        String id = id_example; // String | The ID of the post to be retrieved.
        
        try {
            ContentPostV3Response result = apiInstance.getBlogPost(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String id = id_example; // String | The ID of the post to be retrieved.
        
        try {
            ContentPostV3Response result = apiInstance.getBlogPost(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];
String *id = id_example; // The ID of the post to be retrieved. (default to null)

// Get Blog Post
[apiInstance getBlogPostWith:id
              completionHandler: ^(ContentPostV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var id = id_example; // {String} The ID of the post to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBlogPost(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBlogPostExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();
            var id = id_example;  // String | The ID of the post to be retrieved. (default to null)

            try {
                // Get Blog Post
                ContentPostV3Response result = apiInstance.getBlogPost(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();
$id = id_example; // String | The ID of the post to be retrieved.

try {
    $result = $api_instance->getBlogPost($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();
my $id = id_example; # String | The ID of the post to be retrieved.

eval { 
    my $result = $api_instance->getBlogPost(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()
id = id_example # String | The ID of the post to be retrieved. (default to null)

try: 
    # Get Blog Post
    api_response = api_instance.get_blog_post(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getBlogPost: %s\n" % e)
extern crate ContentApi;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentApi::Context::default();
    let result = client.getBlogPost(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the post to be retrieved.
Required

Responses


getContent

Get Content

TODO


/api/v3/content/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];

// Get Content
[apiInstance getContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();

            try {
                // Get Content
                oas_any_type_not_mapped result = apiInstance.getContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();

try {
    $result = $api_instance->getContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();

eval { 
    my $result = $api_instance->getContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()

try: 
    # Get Content
    api_response = api_instance.get_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getContent: %s\n" % e)
extern crate ContentApi;

pub fn main() {

    let mut context = ContentApi::Context::default();
    let result = client.getContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreatorBlogPosts

Get Creator Blog Posts

Retrieve a paginated list of blog posts from a creator. Or search for blog posts from a creator.


/api/v3/content/creator

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/creator?id=&limit=&fetchAfter=&search="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        String id = id_example; // String | The GUID of the creator to retrieve posts from.
        Integer limit = 56; // Integer | The maximum number of posts to return.
        Integer fetchAfter = 56; // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
        String search = search_example; // String | Search filter to look for specific posts.
        
        try {
            array[BlogPostModelV3] result = apiInstance.getCreatorBlogPosts(id, limit, fetchAfter, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String id = id_example; // String | The GUID of the creator to retrieve posts from.
        Integer limit = 56; // Integer | The maximum number of posts to return.
        Integer fetchAfter = 56; // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
        String search = search_example; // String | Search filter to look for specific posts.
        
        try {
            array[BlogPostModelV3] result = apiInstance.getCreatorBlogPosts(id, limit, fetchAfter, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];
String *id = id_example; // The GUID of the creator to retrieve posts from. (default to null)
Integer *limit = 56; // The maximum number of posts to return. (default to null)
Integer *fetchAfter = 56; // The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. (optional) (default to null)
String *search = search_example; // Search filter to look for specific posts. (optional) (default to null)

// Get Creator Blog Posts
[apiInstance getCreatorBlogPostsWith:id
    limit:limit
    fetchAfter:fetchAfter
    search:search
              completionHandler: ^(array[BlogPostModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var id = id_example; // {String} The GUID of the creator to retrieve posts from.
var limit = 56; // {Integer} The maximum number of posts to return.
var opts = {
  'fetchAfter': 56, // {Integer} The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
  'search': search_example // {String} Search filter to look for specific posts.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorBlogPosts(id, limit, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorBlogPostsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();
            var id = id_example;  // String | The GUID of the creator to retrieve posts from. (default to null)
            var limit = 56;  // Integer | The maximum number of posts to return. (default to null)
            var fetchAfter = 56;  // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. (optional)  (default to null)
            var search = search_example;  // String | Search filter to look for specific posts. (optional)  (default to null)

            try {
                // Get Creator Blog Posts
                array[BlogPostModelV3] result = apiInstance.getCreatorBlogPosts(id, limit, fetchAfter, search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getCreatorBlogPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();
$id = id_example; // String | The GUID of the creator to retrieve posts from.
$limit = 56; // Integer | The maximum number of posts to return.
$fetchAfter = 56; // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
$search = search_example; // String | Search filter to look for specific posts.

try {
    $result = $api_instance->getCreatorBlogPosts($id, $limit, $fetchAfter, $search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getCreatorBlogPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();
my $id = id_example; # String | The GUID of the creator to retrieve posts from.
my $limit = 56; # Integer | The maximum number of posts to return.
my $fetchAfter = 56; # Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
my $search = search_example; # String | Search filter to look for specific posts.

eval { 
    my $result = $api_instance->getCreatorBlogPosts(id => $id, limit => $limit, fetchAfter => $fetchAfter, search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getCreatorBlogPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()
id = id_example # String | The GUID of the creator to retrieve posts from. (default to null)
limit = 56 # Integer | The maximum number of posts to return. (default to null)
fetchAfter = 56 # Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. (optional) (default to null)
search = search_example # String | Search filter to look for specific posts. (optional) (default to null)

try: 
    # Get Creator Blog Posts
    api_response = api_instance.get_creator_blog_posts(id, limit, fetchAfter=fetchAfter, search=search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getCreatorBlogPosts: %s\n" % e)
extern crate ContentApi;

pub fn main() {
    let id = id_example; // String
    let limit = 56; // Integer
    let fetchAfter = 56; // Integer
    let search = search_example; // String

    let mut context = ContentApi::Context::default();
    let result = client.getCreatorBlogPosts(id, limit, fetchAfter, search, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the creator to retrieve posts from.
Required
limit*
Integer
The maximum number of posts to return.
Required
fetchAfter
Integer
The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
search

Responses


getGalleryContent

Get Gallery Content

TODO


/api/v3/content/gallery

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/gallery"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getGalleryContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getGalleryContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getGalleryContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getGalleryContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];

// Get Gallery Content
[apiInstance getGalleryContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGalleryContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getGalleryContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();

            try {
                // Get Gallery Content
                oas_any_type_not_mapped result = apiInstance.getGalleryContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getGalleryContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();

try {
    $result = $api_instance->getGalleryContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getGalleryContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();

eval { 
    my $result = $api_instance->getGalleryContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getGalleryContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()

try: 
    # Get Gallery Content
    api_response = api_instance.get_gallery_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getGalleryContent: %s\n" % e)
extern crate ContentApi;

pub fn main() {

    let mut context = ContentApi::Context::default();
    let result = client.getGalleryContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getMultiCreatorBlogPosts

Get Multi Creator Blog Posts

Retrieve paginated blog posts from multiple creators for the home page.


/api/v3/content/creator/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/creator/list?ids=&limit=&fetchAfter="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        array[String] ids = ; // array[String] | The GUID(s) of the creator(s) to retrieve posts from.
        Integer limit = 56; // Integer | The maximum number of posts to retrieve.
        array[fetchAfter] fetchAfter = ; // array[fetchAfter] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The purpose of `moreFetchable` in the request is unknown.
        
        try {
            ContentCreatorListV3Response result = apiInstance.getMultiCreatorBlogPosts(ids, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getMultiCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        array[String] ids = ; // array[String] | The GUID(s) of the creator(s) to retrieve posts from.
        Integer limit = 56; // Integer | The maximum number of posts to retrieve.
        array[fetchAfter] fetchAfter = ; // array[fetchAfter] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The purpose of `moreFetchable` in the request is unknown.
        
        try {
            ContentCreatorListV3Response result = apiInstance.getMultiCreatorBlogPosts(ids, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getMultiCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];
array[String] *ids = ; // The GUID(s) of the creator(s) to retrieve posts from. (default to null)
Integer *limit = 56; // The maximum number of posts to retrieve. (default to null)
array[fetchAfter] *fetchAfter = ; // For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The purpose of `moreFetchable` in the request is unknown. (optional) (default to null)

// Get Multi Creator Blog Posts
[apiInstance getMultiCreatorBlogPostsWith:ids
    limit:limit
    fetchAfter:fetchAfter
              completionHandler: ^(ContentCreatorListV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var ids = ; // {array[String]} The GUID(s) of the creator(s) to retrieve posts from.
var limit = 56; // {Integer} The maximum number of posts to retrieve.
var opts = {
  'fetchAfter':  // {array[fetchAfter]} For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The purpose of `moreFetchable` in the request is unknown.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMultiCreatorBlogPosts(ids, limit, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMultiCreatorBlogPostsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();
            var ids = new array[String](); // array[String] | The GUID(s) of the creator(s) to retrieve posts from. (default to null)
            var limit = 56;  // Integer | The maximum number of posts to retrieve. (default to null)
            var fetchAfter = new array[fetchAfter](); // array[fetchAfter] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The purpose of `moreFetchable` in the request is unknown. (optional)  (default to null)

            try {
                // Get Multi Creator Blog Posts
                ContentCreatorListV3Response result = apiInstance.getMultiCreatorBlogPosts(ids, limit, fetchAfter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getMultiCreatorBlogPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();
$ids = ; // array[String] | The GUID(s) of the creator(s) to retrieve posts from.
$limit = 56; // Integer | The maximum number of posts to retrieve.
$fetchAfter = ; // array[fetchAfter] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The purpose of `moreFetchable` in the request is unknown.

try {
    $result = $api_instance->getMultiCreatorBlogPosts($ids, $limit, $fetchAfter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getMultiCreatorBlogPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();
my $ids = []; # array[String] | The GUID(s) of the creator(s) to retrieve posts from.
my $limit = 56; # Integer | The maximum number of posts to retrieve.
my $fetchAfter = []; # array[fetchAfter] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The purpose of `moreFetchable` in the request is unknown.

eval { 
    my $result = $api_instance->getMultiCreatorBlogPosts(ids => $ids, limit => $limit, fetchAfter => $fetchAfter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getMultiCreatorBlogPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()
ids =  # array[String] | The GUID(s) of the creator(s) to retrieve posts from. (default to null)
limit = 56 # Integer | The maximum number of posts to retrieve. (default to null)
fetchAfter =  # array[fetchAfter] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The purpose of `moreFetchable` in the request is unknown. (optional) (default to null)

try: 
    # Get Multi Creator Blog Posts
    api_response = api_instance.get_multi_creator_blog_posts(ids, limit, fetchAfter=fetchAfter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getMultiCreatorBlogPosts: %s\n" % e)
extern crate ContentApi;

pub fn main() {
    let ids = ; // array[String]
    let limit = 56; // Integer
    let fetchAfter = ; // array[fetchAfter]

    let mut context = ContentApi::Context::default();
    let result = client.getMultiCreatorBlogPosts(ids, limit, fetchAfter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
ids*
array[String]
The GUID(s) of the creator(s) to retrieve posts from.
Required
limit*
Integer
The maximum number of posts to retrieve.
Required
fetchAfter
array[fetchAfter]
For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The purpose of `moreFetchable` in the request is unknown.

Responses


getPictureContent

Get Picture Content

TODO


/api/v3/content/picture

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/picture"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPictureContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getPictureContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPictureContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getPictureContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];

// Get Picture Content
[apiInstance getPictureContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPictureContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPictureContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();

            try {
                // Get Picture Content
                oas_any_type_not_mapped result = apiInstance.getPictureContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getPictureContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();

try {
    $result = $api_instance->getPictureContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getPictureContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();

eval { 
    my $result = $api_instance->getPictureContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getPictureContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()

try: 
    # Get Picture Content
    api_response = api_instance.get_picture_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getPictureContent: %s\n" % e)
extern crate ContentApi;

pub fn main() {

    let mut context = ContentApi::Context::default();
    let result = client.getPictureContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getPictureUrl

Get Picture Url

TODO


/api/v3/content/picture/url

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/picture/url"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPictureUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getPictureUrl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPictureUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getPictureUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];

// Get Picture Url
[apiInstance getPictureUrlWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPictureUrl(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPictureUrlExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();

            try {
                // Get Picture Url
                oas_any_type_not_mapped result = apiInstance.getPictureUrl();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getPictureUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();

try {
    $result = $api_instance->getPictureUrl();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getPictureUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();

eval { 
    my $result = $api_instance->getPictureUrl();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getPictureUrl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()

try: 
    # Get Picture Url
    api_response = api_instance.get_picture_url()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getPictureUrl: %s\n" % e)
extern crate ContentApi;

pub fn main() {

    let mut context = ContentApi::Context::default();
    let result = client.getPictureUrl(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getRelatedBlogPosts

Get Related Blog Posts

Retrieve a list of blog posts that are related to the post being viewed.


/api/v3/content/related

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/related?id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        String id = id_example; // String | The ID of the originating post.
        
        try {
            array[BlogPostModelV3] result = apiInstance.getRelatedBlogPosts(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getRelatedBlogPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String id = id_example; // String | The ID of the originating post.
        
        try {
            array[BlogPostModelV3] result = apiInstance.getRelatedBlogPosts(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getRelatedBlogPosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];
String *id = id_example; // The ID of the originating post. (default to null)

// Get Related Blog Posts
[apiInstance getRelatedBlogPostsWith:id
              completionHandler: ^(array[BlogPostModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var id = id_example; // {String} The ID of the originating post.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRelatedBlogPosts(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRelatedBlogPostsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();
            var id = id_example;  // String | The ID of the originating post. (default to null)

            try {
                // Get Related Blog Posts
                array[BlogPostModelV3] result = apiInstance.getRelatedBlogPosts(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getRelatedBlogPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();
$id = id_example; // String | The ID of the originating post.

try {
    $result = $api_instance->getRelatedBlogPosts($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getRelatedBlogPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();
my $id = id_example; # String | The ID of the originating post.

eval { 
    my $result = $api_instance->getRelatedBlogPosts(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getRelatedBlogPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()
id = id_example # String | The ID of the originating post. (default to null)

try: 
    # Get Related Blog Posts
    api_response = api_instance.get_related_blog_posts(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getRelatedBlogPosts: %s\n" % e)
extern crate ContentApi;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentApi::Context::default();
    let result = client.getRelatedBlogPosts(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the originating post.
Required

Responses


getVideoContent

Get Video Content

Retrieve more information on a video attachment from a blog post in order to consume the video content.


/api/v3/content/video

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/video?id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        String id = id_example; // String | The ID of the video attachment object, from the `BlogPostModelV3`.
        
        try {
            ContentVideoV3Response result = apiInstance.getVideoContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getVideoContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        String id = id_example; // String | The ID of the video attachment object, from the `BlogPostModelV3`.
        
        try {
            ContentVideoV3Response result = apiInstance.getVideoContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#getVideoContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];
String *id = id_example; // The ID of the video attachment object, from the `BlogPostModelV3`. (default to null)

// Get Video Content
[apiInstance getVideoContentWith:id
              completionHandler: ^(ContentVideoV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var id = id_example; // {String} The ID of the video attachment object, from the `BlogPostModelV3`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoContent(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVideoContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();
            var id = id_example;  // String | The ID of the video attachment object, from the `BlogPostModelV3`. (default to null)

            try {
                // Get Video Content
                ContentVideoV3Response result = apiInstance.getVideoContent(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.getVideoContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();
$id = id_example; // String | The ID of the video attachment object, from the `BlogPostModelV3`.

try {
    $result = $api_instance->getVideoContent($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->getVideoContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();
my $id = id_example; # String | The ID of the video attachment object, from the `BlogPostModelV3`.

eval { 
    my $result = $api_instance->getVideoContent(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->getVideoContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()
id = id_example # String | The ID of the video attachment object, from the `BlogPostModelV3`. (default to null)

try: 
    # Get Video Content
    api_response = api_instance.get_video_content(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->getVideoContent: %s\n" % e)
extern crate ContentApi;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentApi::Context::default();
    let result = client.getVideoContent(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the video attachment object, from the `BlogPostModelV3`.
Required

Responses


likeContent

Like Content

TODO


/api/v3/content/like

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/like"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentApi;

import java.io.File;
import java.util.*;

public class ContentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.likeContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#likeContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentApi;

public class ContentApiExample {
    public static void main(String[] args) {
        ContentApi apiInstance = new ContentApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.likeContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentApi#likeContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentApi *apiInstance = [[ContentApi alloc] init];

// Like Content
[apiInstance likeContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.likeContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class likeContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentApi();

            try {
                // Like Content
                oas_any_type_not_mapped result = apiInstance.likeContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentApi.likeContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentApi();

try {
    $result = $api_instance->likeContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->likeContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentApi->new();

eval { 
    my $result = $api_instance->likeContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentApi->likeContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentApi()

try: 
    # Like Content
    api_response = api_instance.like_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentApi->likeContent: %s\n" % e)
extern crate ContentApi;

pub fn main() {

    let mut context = ContentApi::Context::default();
    let result = client.likeContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ContentUpload

abortMultipartUploadV3

Abort Multipart Upload

TODO


/api/v3/content/upload/s3/multipart/abort

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart/abort"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadApi;

import java.io.File;
import java.util.*;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#abortMultipartUploadV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadApi;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#abortMultipartUploadV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentUploadApi *apiInstance = [[ContentUploadApi alloc] init];

// Abort Multipart Upload
[apiInstance abortMultipartUploadV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.abortMultipartUploadV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class abortMultipartUploadV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentUploadApi();

            try {
                // Abort Multipart Upload
                oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadApi.abortMultipartUploadV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadApi();

try {
    $result = $api_instance->abortMultipartUploadV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadApi->abortMultipartUploadV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadApi->new();

eval { 
    my $result = $api_instance->abortMultipartUploadV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadApi->abortMultipartUploadV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadApi()

try: 
    # Abort Multipart Upload
    api_response = api_instance.abort_multipart_upload_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadApi->abortMultipartUploadV3: %s\n" % e)
extern crate ContentUploadApi;

pub fn main() {

    let mut context = ContentUploadApi::Context::default();
    let result = client.abortMultipartUploadV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


completeMultipartUploadContent

Complete Multipart Upload

TODO


/api/v3/content/upload/s3/multipart/complete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart/complete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadApi;

import java.io.File;
import java.util.*;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.completeMultipartUploadContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#completeMultipartUploadContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadApi;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.completeMultipartUploadContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#completeMultipartUploadContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentUploadApi *apiInstance = [[ContentUploadApi alloc] init];

// Complete Multipart Upload
[apiInstance completeMultipartUploadContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.completeMultipartUploadContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class completeMultipartUploadContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentUploadApi();

            try {
                // Complete Multipart Upload
                oas_any_type_not_mapped result = apiInstance.completeMultipartUploadContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadApi.completeMultipartUploadContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadApi();

try {
    $result = $api_instance->completeMultipartUploadContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadApi->completeMultipartUploadContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadApi->new();

eval { 
    my $result = $api_instance->completeMultipartUploadContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadApi->completeMultipartUploadContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadApi()

try: 
    # Complete Multipart Upload
    api_response = api_instance.complete_multipart_upload_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadApi->completeMultipartUploadContent: %s\n" % e)
extern crate ContentUploadApi;

pub fn main() {

    let mut context = ContentUploadApi::Context::default();
    let result = client.completeMultipartUploadContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


createMultipartUploadV3

Create Multipart Upload

TODO


/api/v3/content/upload/s3/multipart

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadApi;

import java.io.File;
import java.util.*;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createMultipartUploadV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#createMultipartUploadV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadApi;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createMultipartUploadV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#createMultipartUploadV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentUploadApi *apiInstance = [[ContentUploadApi alloc] init];

// Create Multipart Upload
[apiInstance createMultipartUploadV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMultipartUploadV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createMultipartUploadV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentUploadApi();

            try {
                // Create Multipart Upload
                oas_any_type_not_mapped result = apiInstance.createMultipartUploadV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadApi.createMultipartUploadV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadApi();

try {
    $result = $api_instance->createMultipartUploadV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadApi->createMultipartUploadV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadApi->new();

eval { 
    my $result = $api_instance->createMultipartUploadV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadApi->createMultipartUploadV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadApi()

try: 
    # Create Multipart Upload
    api_response = api_instance.create_multipart_upload_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadApi->createMultipartUploadV3: %s\n" % e)
extern crate ContentUploadApi;

pub fn main() {

    let mut context = ContentUploadApi::Context::default();
    let result = client.createMultipartUploadV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUploadedPartsV3

Get Uploaded Parts

TODO


/api/v3/content/upload/s3/multipart

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadApi;

import java.io.File;
import java.util.*;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUploadedPartsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#getUploadedPartsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadApi;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUploadedPartsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#getUploadedPartsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentUploadApi *apiInstance = [[ContentUploadApi alloc] init];

// Get Uploaded Parts
[apiInstance getUploadedPartsV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUploadedPartsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUploadedPartsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentUploadApi();

            try {
                // Get Uploaded Parts
                oas_any_type_not_mapped result = apiInstance.getUploadedPartsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadApi.getUploadedPartsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadApi();

try {
    $result = $api_instance->getUploadedPartsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadApi->getUploadedPartsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadApi->new();

eval { 
    my $result = $api_instance->getUploadedPartsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadApi->getUploadedPartsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadApi()

try: 
    # Get Uploaded Parts
    api_response = api_instance.get_uploaded_parts_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadApi->getUploadedPartsV3: %s\n" % e)
extern crate ContentUploadApi;

pub fn main() {

    let mut context = ContentUploadApi::Context::default();
    let result = client.getUploadedPartsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


signPartUploadContent

Sign Part Upload

TODO


/api/v3/content/upload/s3/multipart/sign

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/upload/s3/multipart/sign"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadApi;

import java.io.File;
import java.util.*;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.signPartUploadContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#signPartUploadContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadApi;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.signPartUploadContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#signPartUploadContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentUploadApi *apiInstance = [[ContentUploadApi alloc] init];

// Sign Part Upload
[apiInstance signPartUploadContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signPartUploadContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class signPartUploadContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentUploadApi();

            try {
                // Sign Part Upload
                oas_any_type_not_mapped result = apiInstance.signPartUploadContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadApi.signPartUploadContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadApi();

try {
    $result = $api_instance->signPartUploadContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadApi->signPartUploadContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadApi->new();

eval { 
    my $result = $api_instance->signPartUploadContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadApi->signPartUploadContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadApi()

try: 
    # Sign Part Upload
    api_response = api_instance.sign_part_upload_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadApi->signPartUploadContent: %s\n" % e)
extern crate ContentUploadApi;

pub fn main() {

    let mut context = ContentUploadApi::Context::default();
    let result = client.signPartUploadContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


thumbnailUpdateSubscribe

Thumbnail Update Subscribe

TODO


/api/v3/content/thumbnail/subscribe

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/thumbnail/subscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadApi;

import java.io.File;
import java.util.*;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.thumbnailUpdateSubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#thumbnailUpdateSubscribe");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadApi;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.thumbnailUpdateSubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#thumbnailUpdateSubscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentUploadApi *apiInstance = [[ContentUploadApi alloc] init];

// Thumbnail Update Subscribe
[apiInstance thumbnailUpdateSubscribeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.thumbnailUpdateSubscribe(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class thumbnailUpdateSubscribeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentUploadApi();

            try {
                // Thumbnail Update Subscribe
                oas_any_type_not_mapped result = apiInstance.thumbnailUpdateSubscribe();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadApi.thumbnailUpdateSubscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadApi();

try {
    $result = $api_instance->thumbnailUpdateSubscribe();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadApi->thumbnailUpdateSubscribe: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadApi->new();

eval { 
    my $result = $api_instance->thumbnailUpdateSubscribe();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadApi->thumbnailUpdateSubscribe: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadApi()

try: 
    # Thumbnail Update Subscribe
    api_response = api_instance.thumbnail_update_subscribe()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadApi->thumbnailUpdateSubscribe: %s\n" % e)
extern crate ContentUploadApi;

pub fn main() {

    let mut context = ContentUploadApi::Context::default();
    let result = client.thumbnailUpdateSubscribe(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


uploadThumbnailV3

Upload Thumbnail

TODO


/api/v3/content/upload/thumbnail

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/upload/thumbnail"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentUploadApi;

import java.io.File;
import java.util.*;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadThumbnailV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#uploadThumbnailV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentUploadApi;

public class ContentUploadApiExample {
    public static void main(String[] args) {
        ContentUploadApi apiInstance = new ContentUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadThumbnailV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentUploadApi#uploadThumbnailV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentUploadApi *apiInstance = [[ContentUploadApi alloc] init];

// Upload Thumbnail
[apiInstance uploadThumbnailV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ContentUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadThumbnailV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadThumbnailV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ContentUploadApi();

            try {
                // Upload Thumbnail
                oas_any_type_not_mapped result = apiInstance.uploadThumbnailV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentUploadApi.uploadThumbnailV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentUploadApi();

try {
    $result = $api_instance->uploadThumbnailV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentUploadApi->uploadThumbnailV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentUploadApi->new();

eval { 
    my $result = $api_instance->uploadThumbnailV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentUploadApi->uploadThumbnailV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentUploadApi()

try: 
    # Upload Thumbnail
    api_response = api_instance.upload_thumbnail_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentUploadApi->uploadThumbnailV3: %s\n" % e)
extern crate ContentUploadApi;

pub fn main() {

    let mut context = ContentUploadApi::Context::default();
    let result = client.uploadThumbnailV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Creator

bindCreatorInviteCode

Bind Creator Invite Code

TODO


/api/v3/creator/invite/bind

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/creator/invite/bind"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.bindCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#bindCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.bindCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#bindCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// Bind Creator Invite Code
[apiInstance bindCreatorInviteCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bindCreatorInviteCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class bindCreatorInviteCodeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // Bind Creator Invite Code
                oas_any_type_not_mapped result = apiInstance.bindCreatorInviteCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.bindCreatorInviteCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->bindCreatorInviteCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->bindCreatorInviteCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->bindCreatorInviteCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->bindCreatorInviteCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # Bind Creator Invite Code
    api_response = api_instance.bind_creator_invite_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->bindCreatorInviteCode: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.bindCreatorInviteCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


claimCreatorInviteCode

Claim Creator Invite Code

TODO


/api/v3/creator/invite/claim

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/creator/invite/claim"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.claimCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#claimCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.claimCreatorInviteCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#claimCreatorInviteCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// Claim Creator Invite Code
[apiInstance claimCreatorInviteCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.claimCreatorInviteCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class claimCreatorInviteCodeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // Claim Creator Invite Code
                oas_any_type_not_mapped result = apiInstance.claimCreatorInviteCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.claimCreatorInviteCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->claimCreatorInviteCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->claimCreatorInviteCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->claimCreatorInviteCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->claimCreatorInviteCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # Claim Creator Invite Code
    api_response = api_instance.claim_creator_invite_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->claimCreatorInviteCode: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.claimCreatorInviteCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


discoverCreatorsV2

Discover Creators

TODO


/api/v2/creator/discover

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/discover"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.discoverCreatorsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#discoverCreatorsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.discoverCreatorsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#discoverCreatorsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// Discover Creators
[apiInstance discoverCreatorsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.discoverCreatorsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class discoverCreatorsV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // Discover Creators
                oas_any_type_not_mapped result = apiInstance.discoverCreatorsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.discoverCreatorsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->discoverCreatorsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->discoverCreatorsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->discoverCreatorsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->discoverCreatorsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # Discover Creators
    api_response = api_instance.discover_creators_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->discoverCreatorsV2: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.discoverCreatorsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


discoverCreatorsV3

Discover Creators

TODO


/api/v3/creator/discover

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/creator/discover"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.discoverCreatorsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#discoverCreatorsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.discoverCreatorsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#discoverCreatorsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// Discover Creators
[apiInstance discoverCreatorsV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.discoverCreatorsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class discoverCreatorsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // Discover Creators
                oas_any_type_not_mapped result = apiInstance.discoverCreatorsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.discoverCreatorsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->discoverCreatorsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->discoverCreatorsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->discoverCreatorsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->discoverCreatorsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # Discover Creators
    api_response = api_instance.discover_creators_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->discoverCreatorsV3: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.discoverCreatorsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getChannelInfo

Get Channel Info

TODO


/api/v2/creator/info/get

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/info/get"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getChannelInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getChannelInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getChannelInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getChannelInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// Get Channel Info
[apiInstance getChannelInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChannelInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getChannelInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // Get Channel Info
                oas_any_type_not_mapped result = apiInstance.getChannelInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.getChannelInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->getChannelInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->getChannelInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->getChannelInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->getChannelInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # Get Channel Info
    api_response = api_instance.get_channel_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->getChannelInfo: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.getChannelInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreator

Get Creator

Retrieve detailed information about a specific creator.


/api/v3/creator/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/creator/info?id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        String id = id_example; // String | The GUID of the creator being searched.
        
        try {
            CreatorModelV3 result = apiInstance.getCreator(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        String id = id_example; // String | The GUID of the creator being searched.
        
        try {
            CreatorModelV3 result = apiInstance.getCreator(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];
String *id = id_example; // The GUID of the creator being searched. (default to null)

// Get Creator
[apiInstance getCreatorWith:id
              completionHandler: ^(CreatorModelV3 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var id = id_example; // {String} The GUID of the creator being searched.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreator(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();
            var id = id_example;  // String | The GUID of the creator being searched. (default to null)

            try {
                // Get Creator
                CreatorModelV3 result = apiInstance.getCreator(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.getCreator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();
$id = id_example; // String | The GUID of the creator being searched.

try {
    $result = $api_instance->getCreator($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->getCreator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();
my $id = id_example; # String | The GUID of the creator being searched.

eval { 
    my $result = $api_instance->getCreator(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->getCreator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()
id = id_example # String | The GUID of the creator being searched. (default to null)

try: 
    # Get Creator
    api_response = api_instance.get_creator(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->getCreator: %s\n" % e)
extern crate CreatorApi;

pub fn main() {
    let id = id_example; // String

    let mut context = CreatorApi::Context::default();
    let result = client.getCreator(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the creator being searched.
Required

Responses


getCreatorByName

Get Creator By Name

TODO


/api/v3/creator/named

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/creator/named"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorByName();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreatorByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorByName();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreatorByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// Get Creator By Name
[apiInstance getCreatorByNameWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorByName(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorByNameExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // Get Creator By Name
                oas_any_type_not_mapped result = apiInstance.getCreatorByName();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.getCreatorByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->getCreatorByName();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->getCreatorByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->getCreatorByName();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->getCreatorByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # Get Creator By Name
    api_response = api_instance.get_creator_by_name()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->getCreatorByName: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.getCreatorByName(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreatorInfoByName

Get Info By Name

Retrieve detailed information on one or more creators on Floatplane.


/api/v2/creator/named

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/named?creatorURL="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        array[String] creatorURL = ; // array[String] | The string identifer(s) of the creator(s) to be retrieved.
        
        try {
            array[CreatorModelV2] result = apiInstance.getCreatorInfoByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreatorInfoByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        array[String] creatorURL = ; // array[String] | The string identifer(s) of the creator(s) to be retrieved.
        
        try {
            array[CreatorModelV2] result = apiInstance.getCreatorInfoByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreatorInfoByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];
array[String] *creatorURL = ; // The string identifer(s) of the creator(s) to be retrieved. (default to null)

// Get Info By Name
[apiInstance getCreatorInfoByNameWith:creatorURL
              completionHandler: ^(array[CreatorModelV2] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var creatorURL = ; // {array[String]} The string identifer(s) of the creator(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorInfoByName(creatorURL, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorInfoByNameExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();
            var creatorURL = new array[String](); // array[String] | The string identifer(s) of the creator(s) to be retrieved. (default to null)

            try {
                // Get Info By Name
                array[CreatorModelV2] result = apiInstance.getCreatorInfoByName(creatorURL);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.getCreatorInfoByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();
$creatorURL = ; // array[String] | The string identifer(s) of the creator(s) to be retrieved.

try {
    $result = $api_instance->getCreatorInfoByName($creatorURL);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->getCreatorInfoByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();
my $creatorURL = []; # array[String] | The string identifer(s) of the creator(s) to be retrieved.

eval { 
    my $result = $api_instance->getCreatorInfoByName(creatorURL => $creatorURL);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->getCreatorInfoByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()
creatorURL =  # array[String] | The string identifer(s) of the creator(s) to be retrieved. (default to null)

try: 
    # Get Info By Name
    api_response = api_instance.get_creator_info_by_name(creatorURL)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->getCreatorInfoByName: %s\n" % e)
extern crate CreatorApi;

pub fn main() {
    let creatorURL = ; // array[String]

    let mut context = CreatorApi::Context::default();
    let result = client.getCreatorInfoByName(creatorURL, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorURL*
array[String]
The string identifer(s) of the creator(s) to be retrieved.
Required

Responses


getCreatorInviteCodeInfo

Get Creator Invite Code Info

TODO


/api/v3/creator/invite/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/creator/invite/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreatorInviteCodeInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreatorInviteCodeInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// Get Creator Invite Code Info
[apiInstance getCreatorInviteCodeInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorInviteCodeInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorInviteCodeInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // Get Creator Invite Code Info
                oas_any_type_not_mapped result = apiInstance.getCreatorInviteCodeInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.getCreatorInviteCodeInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->getCreatorInviteCodeInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->getCreatorInviteCodeInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->getCreatorInviteCodeInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->getCreatorInviteCodeInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # Get Creator Invite Code Info
    api_response = api_instance.get_creator_invite_code_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->getCreatorInviteCodeInfo: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.getCreatorInviteCodeInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getCreators

Get Creators

Retrieve and search for all creators on Floatplane. Useful for creator discovery and filtering.


/api/v3/creator/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/creator/list?search="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        String search = search_example; // String | Optional search string for finding particular creators on the platform.
        
        try {
            array[CreatorModelV3] result = apiInstance.getCreators(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        String search = search_example; // String | Optional search string for finding particular creators on the platform.
        
        try {
            array[CreatorModelV3] result = apiInstance.getCreators(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getCreators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];
String *search = search_example; // Optional search string for finding particular creators on the platform. (default to null)

// Get Creators
[apiInstance getCreatorsWith:search
              completionHandler: ^(array[CreatorModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var search = search_example; // {String} Optional search string for finding particular creators on the platform.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreators(search, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();
            var search = search_example;  // String | Optional search string for finding particular creators on the platform. (default to null)

            try {
                // Get Creators
                array[CreatorModelV3] result = apiInstance.getCreators(search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.getCreators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();
$search = search_example; // String | Optional search string for finding particular creators on the platform.

try {
    $result = $api_instance->getCreators($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->getCreators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();
my $search = search_example; # String | Optional search string for finding particular creators on the platform.

eval { 
    my $result = $api_instance->getCreators(search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->getCreators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()
search = search_example # String | Optional search string for finding particular creators on the platform. (default to null)

try: 
    # Get Creators
    api_response = api_instance.get_creators(search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->getCreators: %s\n" % e)
extern crate CreatorApi;

pub fn main() {
    let search = search_example; // String

    let mut context = CreatorApi::Context::default();
    let result = client.getCreators(search, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
search*

Responses


getInfo

Get Info

Retrieve detailed information on one or more creators on Floatplane.


/api/v2/creator/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/info?creatorGUID="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        array[String] creatorGUID = ; // array[String] | The GUID identifer(s) of the creator(s) to be retrieved.
        
        try {
            array[CreatorModelV2] result = apiInstance.getInfo(creatorGUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        array[String] creatorGUID = ; // array[String] | The GUID identifer(s) of the creator(s) to be retrieved.
        
        try {
            array[CreatorModelV2] result = apiInstance.getInfo(creatorGUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#getInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];
array[String] *creatorGUID = ; // The GUID identifer(s) of the creator(s) to be retrieved. (default to null)

// Get Info
[apiInstance getInfoWith:creatorGUID
              completionHandler: ^(array[CreatorModelV2] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var creatorGUID = ; // {array[String]} The GUID identifer(s) of the creator(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInfo(creatorGUID, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();
            var creatorGUID = new array[String](); // array[String] | The GUID identifer(s) of the creator(s) to be retrieved. (default to null)

            try {
                // Get Info
                array[CreatorModelV2] result = apiInstance.getInfo(creatorGUID);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.getInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();
$creatorGUID = ; // array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

try {
    $result = $api_instance->getInfo($creatorGUID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->getInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();
my $creatorGUID = []; # array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

eval { 
    my $result = $api_instance->getInfo(creatorGUID => $creatorGUID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->getInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()
creatorGUID =  # array[String] | The GUID identifer(s) of the creator(s) to be retrieved. (default to null)

try: 
    # Get Info
    api_response = api_instance.get_info(creatorGUID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->getInfo: %s\n" % e)
extern crate CreatorApi;

pub fn main() {
    let creatorGUID = ; // array[String]

    let mut context = CreatorApi::Context::default();
    let result = client.getInfo(creatorGUID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorGUID*
array[String]
The GUID identifer(s) of the creator(s) to be retrieved.
Required

Responses



listCreatorCategoriesV2

List Creator Categories

TODO


/api/v2/creatorcategory/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creatorcategory/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listCreatorCategoriesV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listCreatorCategoriesV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// List Creator Categories
[apiInstance listCreatorCategoriesV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorCategoriesV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCreatorCategoriesV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // List Creator Categories
                oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.listCreatorCategoriesV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->listCreatorCategoriesV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->listCreatorCategoriesV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->listCreatorCategoriesV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->listCreatorCategoriesV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # List Creator Categories
    api_response = api_instance.list_creator_categories_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->listCreatorCategoriesV2: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.listCreatorCategoriesV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listCreatorCategoriesV3

List Creator Categories

TODO


/api/v3/creator/category/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/creator/category/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listCreatorCategoriesV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listCreatorCategoriesV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// List Creator Categories
[apiInstance listCreatorCategoriesV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorCategoriesV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCreatorCategoriesV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // List Creator Categories
                oas_any_type_not_mapped result = apiInstance.listCreatorCategoriesV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.listCreatorCategoriesV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->listCreatorCategoriesV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->listCreatorCategoriesV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->listCreatorCategoriesV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->listCreatorCategoriesV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # List Creator Categories
    api_response = api_instance.list_creator_categories_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->listCreatorCategoriesV3: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.listCreatorCategoriesV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listCreators

List Creators

TODO


/api/v2/creator/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listCreators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listCreators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// List Creators
[apiInstance listCreatorsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreators(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCreatorsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // List Creators
                oas_any_type_not_mapped result = apiInstance.listCreators();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.listCreators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->listCreators();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->listCreators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->listCreators();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->listCreators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # List Creators
    api_response = api_instance.list_creators()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->listCreators: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.listCreators(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listPlaylists

List Playlists

TODO


/api/v2/creator/playlists

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/playlists"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listPlaylists();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listPlaylists");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listPlaylists();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listPlaylists");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// List Playlists
[apiInstance listPlaylistsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPlaylists(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listPlaylistsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // List Playlists
                oas_any_type_not_mapped result = apiInstance.listPlaylists();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.listPlaylists: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->listPlaylists();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->listPlaylists: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->listPlaylists();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->listPlaylists: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # List Playlists
    api_response = api_instance.list_playlists()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->listPlaylists: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.listPlaylists(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listVideos

List Videos

TODO


/api/v2/creator/videos

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/videos"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listVideos");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#listVideos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// List Videos
[apiInstance listVideosWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listVideos(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listVideosExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // List Videos
                oas_any_type_not_mapped result = apiInstance.listVideos();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.listVideos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->listVideos();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->listVideos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->listVideos();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->listVideos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # List Videos
    api_response = api_instance.list_videos()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->listVideos: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.listVideos(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateChannelImage

Update Channel Image

TODO


/api/v2/creator/image/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/image/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateChannelImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#updateChannelImage");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateChannelImage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#updateChannelImage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// Update Channel Image
[apiInstance updateChannelImageWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateChannelImage(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateChannelImageExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // Update Channel Image
                oas_any_type_not_mapped result = apiInstance.updateChannelImage();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.updateChannelImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->updateChannelImage();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->updateChannelImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->updateChannelImage();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->updateChannelImage: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # Update Channel Image
    api_response = api_instance.update_channel_image()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->updateChannelImage: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.updateChannelImage(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateChannelInfo

Update Channel Info

TODO


/api/v2/creator/info/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/info/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorApi;

import java.io.File;
import java.util.*;

public class CreatorApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateChannelInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#updateChannelInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorApi;

public class CreatorApiExample {
    public static void main(String[] args) {
        CreatorApi apiInstance = new CreatorApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateChannelInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorApi#updateChannelInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorApi *apiInstance = [[CreatorApi alloc] init];

// Update Channel Info
[apiInstance updateChannelInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateChannelInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateChannelInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorApi();

            try {
                // Update Channel Info
                oas_any_type_not_mapped result = apiInstance.updateChannelInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorApi.updateChannelInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorApi();

try {
    $result = $api_instance->updateChannelInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorApi->updateChannelInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorApi->new();

eval { 
    my $result = $api_instance->updateChannelInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorApi->updateChannelInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorApi()

try: 
    # Update Channel Info
    api_response = api_instance.update_channel_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorApi->updateChannelInfo: %s\n" % e)
extern crate CreatorApi;

pub fn main() {

    let mut context = CreatorApi::Context::default();
    let result = client.updateChannelInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses



CreatorAdministration

addCreatorModeratorAdmin

Add Creator Moderator

TODO


/api/v2/creator/administration/moderators/add

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/administration/moderators/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#addCreatorModeratorAdmin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#addCreatorModeratorAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];

// Add Creator Moderator
[apiInstance addCreatorModeratorAdminWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorAdministrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCreatorModeratorAdmin(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addCreatorModeratorAdminExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();

            try {
                // Add Creator Moderator
                oas_any_type_not_mapped result = apiInstance.addCreatorModeratorAdmin();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.addCreatorModeratorAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();

try {
    $result = $api_instance->addCreatorModeratorAdmin();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->addCreatorModeratorAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();

eval { 
    my $result = $api_instance->addCreatorModeratorAdmin();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->addCreatorModeratorAdmin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()

try: 
    # Add Creator Moderator
    api_response = api_instance.add_creator_moderator_admin()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->addCreatorModeratorAdmin: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.addCreatorModeratorAdmin(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


addCreatorModeratorByPath

Add Creator Moderator By Path

TODO


/api/v2/creators/{creator}/administration/moderators/add

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creators/{creator}/administration/moderators/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#addCreatorModeratorByPath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.addCreatorModeratorByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#addCreatorModeratorByPath");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];
String *creator = creator_example; //  (default to null)

// Add Creator Moderator By Path
[apiInstance addCreatorModeratorByPathWith:creator
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorAdministrationApi()
var creator = creator_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCreatorModeratorByPath(creator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addCreatorModeratorByPathExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();
            var creator = creator_example;  // String |  (default to null)

            try {
                // Add Creator Moderator By Path
                oas_any_type_not_mapped result = apiInstance.addCreatorModeratorByPath(creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.addCreatorModeratorByPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();
$creator = creator_example; // String | 

try {
    $result = $api_instance->addCreatorModeratorByPath($creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->addCreatorModeratorByPath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();
my $creator = creator_example; # String | 

eval { 
    my $result = $api_instance->addCreatorModeratorByPath(creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->addCreatorModeratorByPath: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()
creator = creator_example # String |  (default to null)

try: 
    # Add Creator Moderator By Path
    api_response = api_instance.add_creator_moderator_by_path(creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->addCreatorModeratorByPath: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {
    let creator = creator_example; // String

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.addCreatorModeratorByPath(creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
creator*
String
Required

Responses


listModerators

List Moderators

TODO


/api/v2/creator/administration/moderators/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/administration/moderators/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listModerators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#listModerators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listModerators();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#listModerators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];

// List Moderators
[apiInstance listModeratorsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorAdministrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModerators(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listModeratorsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();

            try {
                // List Moderators
                oas_any_type_not_mapped result = apiInstance.listModerators();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.listModerators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();

try {
    $result = $api_instance->listModerators();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->listModerators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();

eval { 
    my $result = $api_instance->listModerators();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->listModerators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()

try: 
    # List Moderators
    api_response = api_instance.list_moderators()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->listModerators: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.listModerators(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listModeratorsByPath

List Moderators By Path

TODO


/api/v2/creators/{creator}/administration/moderators/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creators/{creator}/administration/moderators/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.listModeratorsByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#listModeratorsByPath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.listModeratorsByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#listModeratorsByPath");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];
String *creator = creator_example; //  (default to null)

// List Moderators By Path
[apiInstance listModeratorsByPathWith:creator
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorAdministrationApi()
var creator = creator_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModeratorsByPath(creator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listModeratorsByPathExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();
            var creator = creator_example;  // String |  (default to null)

            try {
                // List Moderators By Path
                oas_any_type_not_mapped result = apiInstance.listModeratorsByPath(creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.listModeratorsByPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();
$creator = creator_example; // String | 

try {
    $result = $api_instance->listModeratorsByPath($creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->listModeratorsByPath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();
my $creator = creator_example; # String | 

eval { 
    my $result = $api_instance->listModeratorsByPath(creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->listModeratorsByPath: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()
creator = creator_example # String |  (default to null)

try: 
    # List Moderators By Path
    api_response = api_instance.list_moderators_by_path(creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->listModeratorsByPath: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {
    let creator = creator_example; // String

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.listModeratorsByPath(creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
creator*
String
Required

Responses


removeCreatorModeratorAdmin

Remove Creator Moderator

TODO


/api/v2/creator/administration/moderators/remove

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creator/administration/moderators/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#removeCreatorModeratorAdmin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorAdmin();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#removeCreatorModeratorAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];

// Remove Creator Moderator
[apiInstance removeCreatorModeratorAdminWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorAdministrationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeCreatorModeratorAdmin(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class removeCreatorModeratorAdminExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();

            try {
                // Remove Creator Moderator
                oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorAdmin();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.removeCreatorModeratorAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();

try {
    $result = $api_instance->removeCreatorModeratorAdmin();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->removeCreatorModeratorAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();

eval { 
    my $result = $api_instance->removeCreatorModeratorAdmin();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->removeCreatorModeratorAdmin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()

try: 
    # Remove Creator Moderator
    api_response = api_instance.remove_creator_moderator_admin()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->removeCreatorModeratorAdmin: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.removeCreatorModeratorAdmin(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


removeCreatorModeratorByPath

Remove Creator Moderator By Path

TODO


/api/v2/creators/{creator}/administration/moderators/remove

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creators/{creator}/administration/moderators/remove"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAdministrationApi;

import java.io.File;
import java.util.*;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#removeCreatorModeratorByPath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAdministrationApi;

public class CreatorAdministrationApiExample {
    public static void main(String[] args) {
        CreatorAdministrationApi apiInstance = new CreatorAdministrationApi();
        String creator = creator_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorByPath(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAdministrationApi#removeCreatorModeratorByPath");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorAdministrationApi *apiInstance = [[CreatorAdministrationApi alloc] init];
String *creator = creator_example; //  (default to null)

// Remove Creator Moderator By Path
[apiInstance removeCreatorModeratorByPathWith:creator
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorAdministrationApi()
var creator = creator_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeCreatorModeratorByPath(creator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class removeCreatorModeratorByPathExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorAdministrationApi();
            var creator = creator_example;  // String |  (default to null)

            try {
                // Remove Creator Moderator By Path
                oas_any_type_not_mapped result = apiInstance.removeCreatorModeratorByPath(creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAdministrationApi.removeCreatorModeratorByPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAdministrationApi();
$creator = creator_example; // String | 

try {
    $result = $api_instance->removeCreatorModeratorByPath($creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAdministrationApi->removeCreatorModeratorByPath: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAdministrationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAdministrationApi->new();
my $creator = creator_example; # String | 

eval { 
    my $result = $api_instance->removeCreatorModeratorByPath(creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAdministrationApi->removeCreatorModeratorByPath: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAdministrationApi()
creator = creator_example # String |  (default to null)

try: 
    # Remove Creator Moderator By Path
    api_response = api_instance.remove_creator_moderator_by_path(creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAdministrationApi->removeCreatorModeratorByPath: %s\n" % e)
extern crate CreatorAdministrationApi;

pub fn main() {
    let creator = creator_example; // String

    let mut context = CreatorAdministrationApi::Context::default();
    let result = client.removeCreatorModeratorByPath(creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
creator*
String
Required

Responses


CreatorAgreement

confirmAgreement

Confirm Agreement

TODO


/api/v2/api/creator/agreement/confirm

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/api/creator/agreement/confirm"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAgreementApi;

import java.io.File;
import java.util.*;

public class CreatorAgreementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorAgreementApi apiInstance = new CreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.confirmAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAgreementApi#confirmAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAgreementApi;

public class CreatorAgreementApiExample {
    public static void main(String[] args) {
        CreatorAgreementApi apiInstance = new CreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.confirmAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAgreementApi#confirmAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorAgreementApi *apiInstance = [[CreatorAgreementApi alloc] init];

// Confirm Agreement
[apiInstance confirmAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorAgreementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class confirmAgreementExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorAgreementApi();

            try {
                // Confirm Agreement
                oas_any_type_not_mapped result = apiInstance.confirmAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAgreementApi.confirmAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAgreementApi();

try {
    $result = $api_instance->confirmAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAgreementApi->confirmAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAgreementApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAgreementApi->new();

eval { 
    my $result = $api_instance->confirmAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAgreementApi->confirmAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAgreementApi()

try: 
    # Confirm Agreement
    api_response = api_instance.confirm_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAgreementApi->confirmAgreement: %s\n" % e)
extern crate CreatorAgreementApi;

pub fn main() {

    let mut context = CreatorAgreementApi::Context::default();
    let result = client.confirmAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getAgreement

Get Agreement

TODO


/api/v2/api/creator/agreement/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/api/creator/agreement/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorAgreementApi;

import java.io.File;
import java.util.*;

public class CreatorAgreementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorAgreementApi apiInstance = new CreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAgreementApi#getAgreement");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorAgreementApi;

public class CreatorAgreementApiExample {
    public static void main(String[] args) {
        CreatorAgreementApi apiInstance = new CreatorAgreementApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAgreement();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorAgreementApi#getAgreement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorAgreementApi *apiInstance = [[CreatorAgreementApi alloc] init];

// Get Agreement
[apiInstance getAgreementWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorAgreementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAgreement(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAgreementExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorAgreementApi();

            try {
                // Get Agreement
                oas_any_type_not_mapped result = apiInstance.getAgreement();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorAgreementApi.getAgreement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorAgreementApi();

try {
    $result = $api_instance->getAgreement();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorAgreementApi->getAgreement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorAgreementApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorAgreementApi->new();

eval { 
    my $result = $api_instance->getAgreement();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorAgreementApi->getAgreement: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorAgreementApi()

try: 
    # Get Agreement
    api_response = api_instance.get_agreement()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorAgreementApi->getAgreement: %s\n" % e)
extern crate CreatorAgreementApi;

pub fn main() {

    let mut context = CreatorAgreementApi::Context::default();
    let result = client.getAgreement(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


CreatorPlanFeatureLevels

calculateCreatorPlanFeatureCosts

Calculate Creator Plan Feature Costs

TODO


/api/v2/creatorplanfeaturelevel/cost

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creatorplanfeaturelevel/cost"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorPlanFeatureLevelsApi;

import java.io.File;
import java.util.*;

public class CreatorPlanFeatureLevelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorPlanFeatureLevelsApi apiInstance = new CreatorPlanFeatureLevelsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.calculateCreatorPlanFeatureCosts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsApi#calculateCreatorPlanFeatureCosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorPlanFeatureLevelsApi;

public class CreatorPlanFeatureLevelsApiExample {
    public static void main(String[] args) {
        CreatorPlanFeatureLevelsApi apiInstance = new CreatorPlanFeatureLevelsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.calculateCreatorPlanFeatureCosts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsApi#calculateCreatorPlanFeatureCosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorPlanFeatureLevelsApi *apiInstance = [[CreatorPlanFeatureLevelsApi alloc] init];

// Calculate Creator Plan Feature Costs
[apiInstance calculateCreatorPlanFeatureCostsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorPlanFeatureLevelsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateCreatorPlanFeatureCosts(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class calculateCreatorPlanFeatureCostsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorPlanFeatureLevelsApi();

            try {
                // Calculate Creator Plan Feature Costs
                oas_any_type_not_mapped result = apiInstance.calculateCreatorPlanFeatureCosts();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorPlanFeatureLevelsApi.calculateCreatorPlanFeatureCosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorPlanFeatureLevelsApi();

try {
    $result = $api_instance->calculateCreatorPlanFeatureCosts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorPlanFeatureLevelsApi->calculateCreatorPlanFeatureCosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorPlanFeatureLevelsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorPlanFeatureLevelsApi->new();

eval { 
    my $result = $api_instance->calculateCreatorPlanFeatureCosts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorPlanFeatureLevelsApi->calculateCreatorPlanFeatureCosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorPlanFeatureLevelsApi()

try: 
    # Calculate Creator Plan Feature Costs
    api_response = api_instance.calculate_creator_plan_feature_costs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorPlanFeatureLevelsApi->calculateCreatorPlanFeatureCosts: %s\n" % e)
extern crate CreatorPlanFeatureLevelsApi;

pub fn main() {

    let mut context = CreatorPlanFeatureLevelsApi::Context::default();
    let result = client.calculateCreatorPlanFeatureCosts(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listCreatorPlanFeatureLevels

List Creator Plan Feature Levels

TODO


/api/v2/creatorplanfeaturelevel/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/creatorplanfeaturelevel/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorPlanFeatureLevelsApi;

import java.io.File;
import java.util.*;

public class CreatorPlanFeatureLevelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorPlanFeatureLevelsApi apiInstance = new CreatorPlanFeatureLevelsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorPlanFeatureLevels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsApi#listCreatorPlanFeatureLevels");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorPlanFeatureLevelsApi;

public class CreatorPlanFeatureLevelsApiExample {
    public static void main(String[] args) {
        CreatorPlanFeatureLevelsApi apiInstance = new CreatorPlanFeatureLevelsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listCreatorPlanFeatureLevels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsApi#listCreatorPlanFeatureLevels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorPlanFeatureLevelsApi *apiInstance = [[CreatorPlanFeatureLevelsApi alloc] init];

// List Creator Plan Feature Levels
[apiInstance listCreatorPlanFeatureLevelsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorPlanFeatureLevelsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorPlanFeatureLevels(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCreatorPlanFeatureLevelsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorPlanFeatureLevelsApi();

            try {
                // List Creator Plan Feature Levels
                oas_any_type_not_mapped result = apiInstance.listCreatorPlanFeatureLevels();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorPlanFeatureLevelsApi.listCreatorPlanFeatureLevels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorPlanFeatureLevelsApi();

try {
    $result = $api_instance->listCreatorPlanFeatureLevels();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorPlanFeatureLevelsApi->listCreatorPlanFeatureLevels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorPlanFeatureLevelsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorPlanFeatureLevelsApi->new();

eval { 
    my $result = $api_instance->listCreatorPlanFeatureLevels();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorPlanFeatureLevelsApi->listCreatorPlanFeatureLevels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorPlanFeatureLevelsApi()

try: 
    # List Creator Plan Feature Levels
    api_response = api_instance.list_creator_plan_feature_levels()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorPlanFeatureLevelsApi->listCreatorPlanFeatureLevels: %s\n" % e)
extern crate CreatorPlanFeatureLevelsApi;

pub fn main() {

    let mut context = CreatorPlanFeatureLevelsApi::Context::default();
    let result = client.listCreatorPlanFeatureLevels(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


planFeatureLevels

Plan Feature Levels

TODO


/api/v2/plan/feature/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/plan/feature/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorPlanFeatureLevelsApi;

import java.io.File;
import java.util.*;

public class CreatorPlanFeatureLevelsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorPlanFeatureLevelsApi apiInstance = new CreatorPlanFeatureLevelsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.planFeatureLevels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsApi#planFeatureLevels");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorPlanFeatureLevelsApi;

public class CreatorPlanFeatureLevelsApiExample {
    public static void main(String[] args) {
        CreatorPlanFeatureLevelsApi apiInstance = new CreatorPlanFeatureLevelsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.planFeatureLevels();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorPlanFeatureLevelsApi#planFeatureLevels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorPlanFeatureLevelsApi *apiInstance = [[CreatorPlanFeatureLevelsApi alloc] init];

// Plan Feature Levels
[apiInstance planFeatureLevelsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorPlanFeatureLevelsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.planFeatureLevels(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class planFeatureLevelsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorPlanFeatureLevelsApi();

            try {
                // Plan Feature Levels
                oas_any_type_not_mapped result = apiInstance.planFeatureLevels();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorPlanFeatureLevelsApi.planFeatureLevels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorPlanFeatureLevelsApi();

try {
    $result = $api_instance->planFeatureLevels();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorPlanFeatureLevelsApi->planFeatureLevels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorPlanFeatureLevelsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorPlanFeatureLevelsApi->new();

eval { 
    my $result = $api_instance->planFeatureLevels();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorPlanFeatureLevelsApi->planFeatureLevels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorPlanFeatureLevelsApi()

try: 
    # Plan Feature Levels
    api_response = api_instance.plan_feature_levels()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorPlanFeatureLevelsApi->planFeatureLevels: %s\n" % e)
extern crate CreatorPlanFeatureLevelsApi;

pub fn main() {

    let mut context = CreatorPlanFeatureLevelsApi::Context::default();
    let result = client.planFeatureLevels(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


CreatorSubscriptionPlan

getCreatorSubInfoPublic

Get Creator Sub Info Public

Retrieve detailed information about a creator's subscription plans and their subscriber count.


/api/v2/plan/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/plan/info?creatorId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        String creatorId = creatorId_example; // String | The GUID for the creator being search.
        
        try {
            PlanInfoV2Response result = apiInstance.getCreatorSubInfoPublic(creatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#getCreatorSubInfoPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        String creatorId = creatorId_example; // String | The GUID for the creator being search.
        
        try {
            PlanInfoV2Response result = apiInstance.getCreatorSubInfoPublic(creatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#getCreatorSubInfoPublic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorSubscriptionPlanApi *apiInstance = [[CreatorSubscriptionPlanApi alloc] init];
String *creatorId = creatorId_example; // The GUID for the creator being search. (default to null)

// Get Creator Sub Info Public
[apiInstance getCreatorSubInfoPublicWith:creatorId
              completionHandler: ^(PlanInfoV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorSubscriptionPlanApi()
var creatorId = creatorId_example; // {String} The GUID for the creator being search.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorSubInfoPublic(creatorId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorSubInfoPublicExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanApi();
            var creatorId = creatorId_example;  // String | The GUID for the creator being search. (default to null)

            try {
                // Get Creator Sub Info Public
                PlanInfoV2Response result = apiInstance.getCreatorSubInfoPublic(creatorId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanApi.getCreatorSubInfoPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanApi();
$creatorId = creatorId_example; // String | The GUID for the creator being search.

try {
    $result = $api_instance->getCreatorSubInfoPublic($creatorId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanApi->getCreatorSubInfoPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanApi->new();
my $creatorId = creatorId_example; # String | The GUID for the creator being search.

eval { 
    my $result = $api_instance->getCreatorSubInfoPublic(creatorId => $creatorId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanApi->getCreatorSubInfoPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanApi()
creatorId = creatorId_example # String | The GUID for the creator being search. (default to null)

try: 
    # Get Creator Sub Info Public
    api_response = api_instance.get_creator_sub_info_public(creatorId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanApi->getCreatorSubInfoPublic: %s\n" % e)
extern crate CreatorSubscriptionPlanApi;

pub fn main() {
    let creatorId = creatorId_example; // String

    let mut context = CreatorSubscriptionPlanApi::Context::default();
    let result = client.getCreatorSubInfoPublic(creatorId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorId*
String
The GUID for the creator being search.
Required

Responses


getPlansForContent

Get Plans For Content

TODO


/api/v3/plan/content

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/plan/content"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPlansForContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#getPlansForContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getPlansForContent();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#getPlansForContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorSubscriptionPlanApi *apiInstance = [[CreatorSubscriptionPlanApi alloc] init];

// Get Plans For Content
[apiInstance getPlansForContentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorSubscriptionPlanApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlansForContent(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPlansForContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanApi();

            try {
                // Get Plans For Content
                oas_any_type_not_mapped result = apiInstance.getPlansForContent();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanApi.getPlansForContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanApi();

try {
    $result = $api_instance->getPlansForContent();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanApi->getPlansForContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanApi->new();

eval { 
    my $result = $api_instance->getPlansForContent();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanApi->getPlansForContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanApi()

try: 
    # Get Plans For Content
    api_response = api_instance.get_plans_for_content()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanApi->getPlansForContent: %s\n" % e)
extern crate CreatorSubscriptionPlanApi;

pub fn main() {

    let mut context = CreatorSubscriptionPlanApi::Context::default();
    let result = client.getPlansForContent(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listSubscriptionPlans

List Subscription Plans

TODO


/api/v2/plan/list

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/plan/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listSubscriptionPlans();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#listSubscriptionPlans");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listSubscriptionPlans();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#listSubscriptionPlans");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorSubscriptionPlanApi *apiInstance = [[CreatorSubscriptionPlanApi alloc] init];

// List Subscription Plans
[apiInstance listSubscriptionPlansWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorSubscriptionPlanApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubscriptionPlans(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listSubscriptionPlansExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanApi();

            try {
                // List Subscription Plans
                oas_any_type_not_mapped result = apiInstance.listSubscriptionPlans();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanApi.listSubscriptionPlans: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanApi();

try {
    $result = $api_instance->listSubscriptionPlans();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanApi->listSubscriptionPlans: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanApi->new();

eval { 
    my $result = $api_instance->listSubscriptionPlans();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanApi->listSubscriptionPlans: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanApi()

try: 
    # List Subscription Plans
    api_response = api_instance.list_subscription_plans()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanApi->listSubscriptionPlans: %s\n" % e)
extern crate CreatorSubscriptionPlanApi;

pub fn main() {

    let mut context = CreatorSubscriptionPlanApi::Context::default();
    let result = client.listSubscriptionPlans(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


publishSubscriptionPlan

Publish Subscription Plan

TODO


/api/v2/plan/publish

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/plan/publish"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.publishSubscriptionPlan();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#publishSubscriptionPlan");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.publishSubscriptionPlan();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#publishSubscriptionPlan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorSubscriptionPlanApi *apiInstance = [[CreatorSubscriptionPlanApi alloc] init];

// Publish Subscription Plan
[apiInstance publishSubscriptionPlanWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorSubscriptionPlanApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publishSubscriptionPlan(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class publishSubscriptionPlanExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanApi();

            try {
                // Publish Subscription Plan
                oas_any_type_not_mapped result = apiInstance.publishSubscriptionPlan();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanApi.publishSubscriptionPlan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanApi();

try {
    $result = $api_instance->publishSubscriptionPlan();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanApi->publishSubscriptionPlan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanApi->new();

eval { 
    my $result = $api_instance->publishSubscriptionPlan();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanApi->publishSubscriptionPlan: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanApi()

try: 
    # Publish Subscription Plan
    api_response = api_instance.publish_subscription_plan()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanApi->publishSubscriptionPlan: %s\n" % e)
extern crate CreatorSubscriptionPlanApi;

pub fn main() {

    let mut context = CreatorSubscriptionPlanApi::Context::default();
    let result = client.publishSubscriptionPlan(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateSubscriptionPlans

Update Subscription Plans

TODO


/api/v2/plan/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/plan/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateSubscriptionPlans();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#updateSubscriptionPlans");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanApi;

public class CreatorSubscriptionPlanApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanApi apiInstance = new CreatorSubscriptionPlanApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateSubscriptionPlans();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanApi#updateSubscriptionPlans");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorSubscriptionPlanApi *apiInstance = [[CreatorSubscriptionPlanApi alloc] init];

// Update Subscription Plans
[apiInstance updateSubscriptionPlansWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.CreatorSubscriptionPlanApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateSubscriptionPlans(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateSubscriptionPlansExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanApi();

            try {
                // Update Subscription Plans
                oas_any_type_not_mapped result = apiInstance.updateSubscriptionPlans();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanApi.updateSubscriptionPlans: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanApi();

try {
    $result = $api_instance->updateSubscriptionPlans();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanApi->updateSubscriptionPlans: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanApi->new();

eval { 
    my $result = $api_instance->updateSubscriptionPlans();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanApi->updateSubscriptionPlans: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanApi()

try: 
    # Update Subscription Plans
    api_response = api_instance.update_subscription_plans()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanApi->updateSubscriptionPlans: %s\n" % e)
extern crate CreatorSubscriptionPlanApi;

pub fn main() {

    let mut context = CreatorSubscriptionPlanApi::Context::default();
    let result = client.updateSubscriptionPlans(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


DiscordBot


getDiscordBotInfo

Info

TODO


/api/v2/discord/bot/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/discord/bot/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscordBotApi;

import java.io.File;
import java.util.*;

public class DiscordBotApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DiscordBotApi apiInstance = new DiscordBotApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getDiscordBotInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotApi#getDiscordBotInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DiscordBotApi;

public class DiscordBotApiExample {
    public static void main(String[] args) {
        DiscordBotApi apiInstance = new DiscordBotApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getDiscordBotInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotApi#getDiscordBotInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
DiscordBotApi *apiInstance = [[DiscordBotApi alloc] init];

// Info
[apiInstance getDiscordBotInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.DiscordBotApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiscordBotInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDiscordBotInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DiscordBotApi();

            try {
                // Info
                oas_any_type_not_mapped result = apiInstance.getDiscordBotInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscordBotApi.getDiscordBotInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscordBotApi();

try {
    $result = $api_instance->getDiscordBotInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscordBotApi->getDiscordBotInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscordBotApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscordBotApi->new();

eval { 
    my $result = $api_instance->getDiscordBotInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscordBotApi->getDiscordBotInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DiscordBotApi()

try: 
    # Info
    api_response = api_instance.get_discord_bot_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscordBotApi->getDiscordBotInfo: %s\n" % e)
extern crate DiscordBotApi;

pub fn main() {

    let mut context = DiscordBotApi::Context::default();
    let result = client.getDiscordBotInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


joinDiscordServers

Join Discord Servers

TODO


/api/v2/discord/server/join

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/discord/server/join"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscordBotApi;

import java.io.File;
import java.util.*;

public class DiscordBotApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DiscordBotApi apiInstance = new DiscordBotApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.joinDiscordServers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotApi#joinDiscordServers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DiscordBotApi;

public class DiscordBotApiExample {
    public static void main(String[] args) {
        DiscordBotApi apiInstance = new DiscordBotApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.joinDiscordServers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotApi#joinDiscordServers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
DiscordBotApi *apiInstance = [[DiscordBotApi alloc] init];

// Join Discord Servers
[apiInstance joinDiscordServersWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.DiscordBotApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.joinDiscordServers(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class joinDiscordServersExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DiscordBotApi();

            try {
                // Join Discord Servers
                oas_any_type_not_mapped result = apiInstance.joinDiscordServers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscordBotApi.joinDiscordServers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscordBotApi();

try {
    $result = $api_instance->joinDiscordServers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscordBotApi->joinDiscordServers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscordBotApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscordBotApi->new();

eval { 
    my $result = $api_instance->joinDiscordServers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscordBotApi->joinDiscordServers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DiscordBotApi()

try: 
    # Join Discord Servers
    api_response = api_instance.join_discord_servers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscordBotApi->joinDiscordServers: %s\n" % e)
extern crate DiscordBotApi;

pub fn main() {

    let mut context = DiscordBotApi::Context::default();
    let result = client.joinDiscordServers(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses



linkCallback

Link Callback

TODO


/api/v2/discord/bot/link/callback

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/discord/bot/link/callback"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscordBotApi;

import java.io.File;
import java.util.*;

public class DiscordBotApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DiscordBotApi apiInstance = new DiscordBotApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.linkCallback();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotApi#linkCallback");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DiscordBotApi;

public class DiscordBotApiExample {
    public static void main(String[] args) {
        DiscordBotApi apiInstance = new DiscordBotApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.linkCallback();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotApi#linkCallback");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
DiscordBotApi *apiInstance = [[DiscordBotApi alloc] init];

// Link Callback
[apiInstance linkCallbackWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.DiscordBotApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.linkCallback(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class linkCallbackExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DiscordBotApi();

            try {
                // Link Callback
                oas_any_type_not_mapped result = apiInstance.linkCallback();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscordBotApi.linkCallback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscordBotApi();

try {
    $result = $api_instance->linkCallback();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscordBotApi->linkCallback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscordBotApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscordBotApi->new();

eval { 
    my $result = $api_instance->linkCallback();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscordBotApi->linkCallback: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DiscordBotApi()

try: 
    # Link Callback
    api_response = api_instance.link_callback()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscordBotApi->linkCallback: %s\n" % e)
extern crate DiscordBotApi;

pub fn main() {

    let mut context = DiscordBotApi::Context::default();
    let result = client.linkCallback(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listDiscordBotConnections

List Connections

TODO


/api/v2/discord/bot/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/discord/bot/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscordBotApi;

import java.io.File;
import java.util.*;

public class DiscordBotApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DiscordBotApi apiInstance = new DiscordBotApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listDiscordBotConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotApi#listDiscordBotConnections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DiscordBotApi;

public class DiscordBotApiExample {
    public static void main(String[] args) {
        DiscordBotApi apiInstance = new DiscordBotApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listDiscordBotConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscordBotApi#listDiscordBotConnections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
DiscordBotApi *apiInstance = [[DiscordBotApi alloc] init];

// List Connections
[apiInstance listDiscordBotConnectionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.DiscordBotApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listDiscordBotConnections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listDiscordBotConnectionsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DiscordBotApi();

            try {
                // List Connections
                oas_any_type_not_mapped result = apiInstance.listDiscordBotConnections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscordBotApi.listDiscordBotConnections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscordBotApi();

try {
    $result = $api_instance->listDiscordBotConnections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscordBotApi->listDiscordBotConnections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscordBotApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscordBotApi->new();

eval { 
    my $result = $api_instance->listDiscordBotConnections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiscordBotApi->listDiscordBotConnections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DiscordBotApi()

try: 
    # List Connections
    api_response = api_instance.list_discord_bot_connections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscordBotApi->listDiscordBotConnections: %s\n" % e)
extern crate DiscordBotApi;

pub fn main() {

    let mut context = DiscordBotApi::Context::default();
    let result = client.listDiscordBotConnections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses




Edges

getEdges

Get Edges

TODO


/api/v2/edges

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/edges"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EdgesApi;

import java.io.File;
import java.util.*;

public class EdgesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        EdgesApi apiInstance = new EdgesApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getEdges();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesApi#getEdges");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EdgesApi;

public class EdgesApiExample {
    public static void main(String[] args) {
        EdgesApi apiInstance = new EdgesApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getEdges();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesApi#getEdges");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
EdgesApi *apiInstance = [[EdgesApi alloc] init];

// Get Edges
[apiInstance getEdgesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.EdgesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEdges(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getEdgesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new EdgesApi();

            try {
                // Get Edges
                oas_any_type_not_mapped result = apiInstance.getEdges();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EdgesApi.getEdges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EdgesApi();

try {
    $result = $api_instance->getEdges();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EdgesApi->getEdges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EdgesApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EdgesApi->new();

eval { 
    my $result = $api_instance->getEdges();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EdgesApi->getEdges: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.EdgesApi()

try: 
    # Get Edges
    api_response = api_instance.get_edges()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EdgesApi->getEdges: %s\n" % e)
extern crate EdgesApi;

pub fn main() {

    let mut context = EdgesApi::Context::default();
    let result = client.getEdges(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getVideoUrl

Get Video Url

TODO


/api/v2/video/url

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/url"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EdgesApi;

import java.io.File;
import java.util.*;

public class EdgesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        EdgesApi apiInstance = new EdgesApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesApi#getVideoUrl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EdgesApi;

public class EdgesApiExample {
    public static void main(String[] args) {
        EdgesApi apiInstance = new EdgesApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesApi#getVideoUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
EdgesApi *apiInstance = [[EdgesApi alloc] init];

// Get Video Url
[apiInstance getVideoUrlWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.EdgesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoUrl(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVideoUrlExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new EdgesApi();

            try {
                // Get Video Url
                oas_any_type_not_mapped result = apiInstance.getVideoUrl();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EdgesApi.getVideoUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EdgesApi();

try {
    $result = $api_instance->getVideoUrl();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EdgesApi->getVideoUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EdgesApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EdgesApi->new();

eval { 
    my $result = $api_instance->getVideoUrl();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EdgesApi->getVideoUrl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.EdgesApi()

try: 
    # Get Video Url
    api_response = api_instance.get_video_url()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EdgesApi->getVideoUrl: %s\n" % e)
extern crate EdgesApi;

pub fn main() {

    let mut context = EdgesApi::Context::default();
    let result = client.getVideoUrl(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


FAQ

getFaqSections

Get Faq Sections

TODO


/api/v2/faq/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/faq/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FAQApi;

import java.io.File;
import java.util.*;

public class FAQApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        FAQApi apiInstance = new FAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FAQApi#getFaqSections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FAQApi;

public class FAQApiExample {
    public static void main(String[] args) {
        FAQApi apiInstance = new FAQApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getFaqSections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FAQApi#getFaqSections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
FAQApi *apiInstance = [[FAQApi alloc] init];

// Get Faq Sections
[apiInstance getFaqSectionsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.FAQApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqSections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFaqSectionsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new FAQApi();

            try {
                // Get Faq Sections
                oas_any_type_not_mapped result = apiInstance.getFaqSections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FAQApi.getFaqSections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FAQApi();

try {
    $result = $api_instance->getFaqSections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAQApi->getFaqSections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FAQApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FAQApi->new();

eval { 
    my $result = $api_instance->getFaqSections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FAQApi->getFaqSections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.FAQApi()

try: 
    # Get Faq Sections
    api_response = api_instance.get_faq_sections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAQApi->getFaqSections: %s\n" % e)
extern crate FAQApi;

pub fn main() {

    let mut context = FAQApi::Context::default();
    let result = client.getFaqSections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Iframe

getVideoPlayer

Get Video Player

TODO


/api/v2/get/player/{guid}

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/get/player/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IframeApi;

import java.io.File;
import java.util.*;

public class IframeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        IframeApi apiInstance = new IframeApi();
        String guid = guid_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoPlayer(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IframeApi#getVideoPlayer");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.IframeApi;

public class IframeApiExample {
    public static void main(String[] args) {
        IframeApi apiInstance = new IframeApi();
        String guid = guid_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoPlayer(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IframeApi#getVideoPlayer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
IframeApi *apiInstance = [[IframeApi alloc] init];
String *guid = guid_example; //  (default to null)

// Get Video Player
[apiInstance getVideoPlayerWith:guid
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.IframeApi()
var guid = guid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoPlayer(guid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVideoPlayerExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new IframeApi();
            var guid = guid_example;  // String |  (default to null)

            try {
                // Get Video Player
                oas_any_type_not_mapped result = apiInstance.getVideoPlayer(guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling IframeApi.getVideoPlayer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IframeApi();
$guid = guid_example; // String | 

try {
    $result = $api_instance->getVideoPlayer($guid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IframeApi->getVideoPlayer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::IframeApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IframeApi->new();
my $guid = guid_example; # String | 

eval { 
    my $result = $api_instance->getVideoPlayer(guid => $guid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IframeApi->getVideoPlayer: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.IframeApi()
guid = guid_example # String |  (default to null)

try: 
    # Get Video Player
    api_response = api_instance.get_video_player(guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IframeApi->getVideoPlayer: %s\n" % e)
extern crate IframeApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = IframeApi::Context::default();
    let result = client.getVideoPlayer(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Required

Responses


ImageOptimizations

getOptimizationsV2

Get Optimizations

TODO


/api/v3/image/optimizations/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/image/optimizations/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ImageOptimizationsApi;

import java.io.File;
import java.util.*;

public class ImageOptimizationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ImageOptimizationsApi apiInstance = new ImageOptimizationsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getOptimizationsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageOptimizationsApi#getOptimizationsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ImageOptimizationsApi;

public class ImageOptimizationsApiExample {
    public static void main(String[] args) {
        ImageOptimizationsApi apiInstance = new ImageOptimizationsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getOptimizationsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageOptimizationsApi#getOptimizationsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ImageOptimizationsApi *apiInstance = [[ImageOptimizationsApi alloc] init];

// Get Optimizations
[apiInstance getOptimizationsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ImageOptimizationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOptimizationsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getOptimizationsV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ImageOptimizationsApi();

            try {
                // Get Optimizations
                oas_any_type_not_mapped result = apiInstance.getOptimizationsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ImageOptimizationsApi.getOptimizationsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ImageOptimizationsApi();

try {
    $result = $api_instance->getOptimizationsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageOptimizationsApi->getOptimizationsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ImageOptimizationsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ImageOptimizationsApi->new();

eval { 
    my $result = $api_instance->getOptimizationsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageOptimizationsApi->getOptimizationsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ImageOptimizationsApi()

try: 
    # Get Optimizations
    api_response = api_instance.get_optimizations_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageOptimizationsApi->getOptimizationsV2: %s\n" % e)
extern crate ImageOptimizationsApi;

pub fn main() {

    let mut context = ImageOptimizationsApi::Context::default();
    let result = client.getOptimizationsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getOptimizationsV3

Get Optimizations

TODO


/api/v2/image/optimizations/

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/image/optimizations/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ImageOptimizationsApi;

import java.io.File;
import java.util.*;

public class ImageOptimizationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ImageOptimizationsApi apiInstance = new ImageOptimizationsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getOptimizationsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageOptimizationsApi#getOptimizationsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ImageOptimizationsApi;

public class ImageOptimizationsApiExample {
    public static void main(String[] args) {
        ImageOptimizationsApi apiInstance = new ImageOptimizationsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getOptimizationsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImageOptimizationsApi#getOptimizationsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ImageOptimizationsApi *apiInstance = [[ImageOptimizationsApi alloc] init];

// Get Optimizations
[apiInstance getOptimizationsV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ImageOptimizationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOptimizationsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getOptimizationsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ImageOptimizationsApi();

            try {
                // Get Optimizations
                oas_any_type_not_mapped result = apiInstance.getOptimizationsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ImageOptimizationsApi.getOptimizationsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ImageOptimizationsApi();

try {
    $result = $api_instance->getOptimizationsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImageOptimizationsApi->getOptimizationsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ImageOptimizationsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ImageOptimizationsApi->new();

eval { 
    my $result = $api_instance->getOptimizationsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImageOptimizationsApi->getOptimizationsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ImageOptimizationsApi()

try: 
    # Get Optimizations
    api_response = api_instance.get_optimizations_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImageOptimizationsApi->getOptimizationsV3: %s\n" % e)
extern crate ImageOptimizationsApi;

pub fn main() {

    let mut context = ImageOptimizationsApi::Context::default();
    let result = client.getOptimizationsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Livestream

renderLivePopout

Render Live Popout

TODO


/v2/live/popout

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/v2/live/popout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LivestreamApi;

import java.io.File;
import java.util.*;

public class LivestreamApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        LivestreamApi apiInstance = new LivestreamApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.renderLivePopout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamApi#renderLivePopout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LivestreamApi;

public class LivestreamApiExample {
    public static void main(String[] args) {
        LivestreamApi apiInstance = new LivestreamApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.renderLivePopout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamApi#renderLivePopout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
LivestreamApi *apiInstance = [[LivestreamApi alloc] init];

// Render Live Popout
[apiInstance renderLivePopoutWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.LivestreamApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.renderLivePopout(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class renderLivePopoutExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new LivestreamApi();

            try {
                // Render Live Popout
                oas_any_type_not_mapped result = apiInstance.renderLivePopout();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LivestreamApi.renderLivePopout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LivestreamApi();

try {
    $result = $api_instance->renderLivePopout();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LivestreamApi->renderLivePopout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LivestreamApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LivestreamApi->new();

eval { 
    my $result = $api_instance->renderLivePopout();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LivestreamApi->renderLivePopout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LivestreamApi()

try: 
    # Render Live Popout
    api_response = api_instance.render_live_popout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LivestreamApi->renderLivePopout: %s\n" % e)
extern crate LivestreamApi;

pub fn main() {

    let mut context = LivestreamApi::Context::default();
    let result = client.renderLivePopout(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateConfig

Update Config

TODO


/api/v2/live/config/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/live/config/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LivestreamApi;

import java.io.File;
import java.util.*;

public class LivestreamApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        LivestreamApi apiInstance = new LivestreamApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateConfig();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamApi#updateConfig");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LivestreamApi;

public class LivestreamApiExample {
    public static void main(String[] args) {
        LivestreamApi apiInstance = new LivestreamApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateConfig();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamApi#updateConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
LivestreamApi *apiInstance = [[LivestreamApi alloc] init];

// Update Config
[apiInstance updateConfigWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.LivestreamApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateConfig(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateConfigExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new LivestreamApi();

            try {
                // Update Config
                oas_any_type_not_mapped result = apiInstance.updateConfig();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LivestreamApi.updateConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LivestreamApi();

try {
    $result = $api_instance->updateConfig();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LivestreamApi->updateConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LivestreamApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LivestreamApi->new();

eval { 
    my $result = $api_instance->updateConfig();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LivestreamApi->updateConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LivestreamApi()

try: 
    # Update Config
    api_response = api_instance.update_config()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LivestreamApi->updateConfig: %s\n" % e)
extern crate LivestreamApi;

pub fn main() {

    let mut context = LivestreamApi::Context::default();
    let result = client.updateConfig(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


uploadLiveThumbnail

Upload Thumbnail

TODO


/api/v2/live/thumbnail/upload

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/live/thumbnail/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LivestreamApi;

import java.io.File;
import java.util.*;

public class LivestreamApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        LivestreamApi apiInstance = new LivestreamApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadLiveThumbnail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamApi#uploadLiveThumbnail");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LivestreamApi;

public class LivestreamApiExample {
    public static void main(String[] args) {
        LivestreamApi apiInstance = new LivestreamApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadLiveThumbnail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LivestreamApi#uploadLiveThumbnail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
LivestreamApi *apiInstance = [[LivestreamApi alloc] init];

// Upload Thumbnail
[apiInstance uploadLiveThumbnailWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.LivestreamApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadLiveThumbnail(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadLiveThumbnailExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new LivestreamApi();

            try {
                // Upload Thumbnail
                oas_any_type_not_mapped result = apiInstance.uploadLiveThumbnail();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LivestreamApi.uploadLiveThumbnail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LivestreamApi();

try {
    $result = $api_instance->uploadLiveThumbnail();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LivestreamApi->uploadLiveThumbnail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LivestreamApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LivestreamApi->new();

eval { 
    my $result = $api_instance->uploadLiveThumbnail();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LivestreamApi->uploadLiveThumbnail: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LivestreamApi()

try: 
    # Upload Thumbnail
    api_response = api_instance.upload_live_thumbnail()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LivestreamApi->uploadLiveThumbnail: %s\n" % e)
extern crate LivestreamApi;

pub fn main() {

    let mut context = LivestreamApi::Context::default();
    let result = client.uploadLiveThumbnail(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


LoyaltyRewards

claimLoyaltyReward

Claim Loyalty Reward

TODO


/api/v3/user/loyaltyreward/claim

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/loyaltyreward/claim"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoyaltyRewardsApi;

import java.io.File;
import java.util.*;

public class LoyaltyRewardsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        LoyaltyRewardsApi apiInstance = new LoyaltyRewardsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.claimLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsApi#claimLoyaltyReward");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LoyaltyRewardsApi;

public class LoyaltyRewardsApiExample {
    public static void main(String[] args) {
        LoyaltyRewardsApi apiInstance = new LoyaltyRewardsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.claimLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsApi#claimLoyaltyReward");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
LoyaltyRewardsApi *apiInstance = [[LoyaltyRewardsApi alloc] init];

// Claim Loyalty Reward
[apiInstance claimLoyaltyRewardWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.LoyaltyRewardsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.claimLoyaltyReward(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class claimLoyaltyRewardExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new LoyaltyRewardsApi();

            try {
                // Claim Loyalty Reward
                oas_any_type_not_mapped result = apiInstance.claimLoyaltyReward();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoyaltyRewardsApi.claimLoyaltyReward: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LoyaltyRewardsApi();

try {
    $result = $api_instance->claimLoyaltyReward();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyRewardsApi->claimLoyaltyReward: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LoyaltyRewardsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LoyaltyRewardsApi->new();

eval { 
    my $result = $api_instance->claimLoyaltyReward();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoyaltyRewardsApi->claimLoyaltyReward: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LoyaltyRewardsApi()

try: 
    # Claim Loyalty Reward
    api_response = api_instance.claim_loyalty_reward()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoyaltyRewardsApi->claimLoyaltyReward: %s\n" % e)
extern crate LoyaltyRewardsApi;

pub fn main() {

    let mut context = LoyaltyRewardsApi::Context::default();
    let result = client.claimLoyaltyReward(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listCreatorLoyaltyReward

List Creator Loyalty Reward

Retrieve a list of loyalty rewards for the user. The reason for why this is a POST and not a GET is unknown.


/api/v3/user/loyaltyreward/list

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/loyaltyreward/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoyaltyRewardsApi;

import java.io.File;
import java.util.*;

public class LoyaltyRewardsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        LoyaltyRewardsApi apiInstance = new LoyaltyRewardsApi();
        
        try {
            array[Object] result = apiInstance.listCreatorLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsApi#listCreatorLoyaltyReward");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LoyaltyRewardsApi;

public class LoyaltyRewardsApiExample {
    public static void main(String[] args) {
        LoyaltyRewardsApi apiInstance = new LoyaltyRewardsApi();
        
        try {
            array[Object] result = apiInstance.listCreatorLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsApi#listCreatorLoyaltyReward");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
LoyaltyRewardsApi *apiInstance = [[LoyaltyRewardsApi alloc] init];

// List Creator Loyalty Reward
[apiInstance listCreatorLoyaltyRewardWithCompletionHandler: 
              ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.LoyaltyRewardsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorLoyaltyReward(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCreatorLoyaltyRewardExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new LoyaltyRewardsApi();

            try {
                // List Creator Loyalty Reward
                array[Object] result = apiInstance.listCreatorLoyaltyReward();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoyaltyRewardsApi.listCreatorLoyaltyReward: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LoyaltyRewardsApi();

try {
    $result = $api_instance->listCreatorLoyaltyReward();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyRewardsApi->listCreatorLoyaltyReward: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LoyaltyRewardsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LoyaltyRewardsApi->new();

eval { 
    my $result = $api_instance->listCreatorLoyaltyReward();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoyaltyRewardsApi->listCreatorLoyaltyReward: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LoyaltyRewardsApi()

try: 
    # List Creator Loyalty Reward
    api_response = api_instance.list_creator_loyalty_reward()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoyaltyRewardsApi->listCreatorLoyaltyReward: %s\n" % e)
extern crate LoyaltyRewardsApi;

pub fn main() {

    let mut context = LoyaltyRewardsApi::Context::default();
    let result = client.listCreatorLoyaltyReward(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Media

deleteVideo

Delete Video

TODO


/api/v2/video/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#deleteVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaApi;

public class MediaApiExample {
    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#deleteVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
MediaApi *apiInstance = [[MediaApi alloc] init];

// Delete Video
[apiInstance deleteVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.MediaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteVideoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new MediaApi();

            try {
                // Delete Video
                oas_any_type_not_mapped result = apiInstance.deleteVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaApi.deleteVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaApi();

try {
    $result = $api_instance->deleteVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->deleteVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaApi->new();

eval { 
    my $result = $api_instance->deleteVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->deleteVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaApi()

try: 
    # Delete Video
    api_response = api_instance.delete_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->deleteVideo: %s\n" % e)
extern crate MediaApi;

pub fn main() {

    let mut context = MediaApi::Context::default();
    let result = client.deleteVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getList

Get List

TODO


/api/v2/video/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaApi;

public class MediaApiExample {
    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
MediaApi *apiInstance = [[MediaApi alloc] init];

// Get List
[apiInstance getListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.MediaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new MediaApi();

            try {
                // Get List
                oas_any_type_not_mapped result = apiInstance.getList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaApi.getList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaApi();

try {
    $result = $api_instance->getList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaApi->new();

eval { 
    my $result = $api_instance->getList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->getList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaApi()

try: 
    # Get List
    api_response = api_instance.get_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->getList: %s\n" % e)
extern crate MediaApi;

pub fn main() {

    let mut context = MediaApi::Context::default();
    let result = client.getList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getRelatedVideos

Get Related Videos

TODO


/api/v2/video/related

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/related"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getRelatedVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getRelatedVideos");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaApi;

public class MediaApiExample {
    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getRelatedVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getRelatedVideos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
MediaApi *apiInstance = [[MediaApi alloc] init];

// Get Related Videos
[apiInstance getRelatedVideosWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.MediaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRelatedVideos(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRelatedVideosExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new MediaApi();

            try {
                // Get Related Videos
                oas_any_type_not_mapped result = apiInstance.getRelatedVideos();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaApi.getRelatedVideos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaApi();

try {
    $result = $api_instance->getRelatedVideos();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getRelatedVideos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaApi->new();

eval { 
    my $result = $api_instance->getRelatedVideos();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->getRelatedVideos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaApi()

try: 
    # Get Related Videos
    api_response = api_instance.get_related_videos()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->getRelatedVideos: %s\n" % e)
extern crate MediaApi;

pub fn main() {

    let mut context = MediaApi::Context::default();
    let result = client.getRelatedVideos(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getVideo

Get Video

TODO


/api/v2/video/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaApi;

public class MediaApiExample {
    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
MediaApi *apiInstance = [[MediaApi alloc] init];

// Get Video
[apiInstance getVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.MediaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVideoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new MediaApi();

            try {
                // Get Video
                oas_any_type_not_mapped result = apiInstance.getVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaApi.getVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaApi();

try {
    $result = $api_instance->getVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaApi->new();

eval { 
    my $result = $api_instance->getVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->getVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaApi()

try: 
    # Get Video
    api_response = api_instance.get_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->getVideo: %s\n" % e)
extern crate MediaApi;

pub fn main() {

    let mut context = MediaApi::Context::default();
    let result = client.getVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateVideo

Update Video

TODO


/api/v2/video/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#updateVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaApi;

public class MediaApiExample {
    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#updateVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
MediaApi *apiInstance = [[MediaApi alloc] init];

// Update Video
[apiInstance updateVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.MediaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateVideoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new MediaApi();

            try {
                // Update Video
                oas_any_type_not_mapped result = apiInstance.updateVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaApi.updateVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaApi();

try {
    $result = $api_instance->updateVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->updateVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaApi->new();

eval { 
    my $result = $api_instance->updateVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->updateVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaApi()

try: 
    # Update Video
    api_response = api_instance.update_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->updateVideo: %s\n" % e)
extern crate MediaApi;

pub fn main() {

    let mut context = MediaApi::Context::default();
    let result = client.updateVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


watchKey

Watch Key

TODO. This seems to originate from the `.m3u8` file captured from the CDN endpoint, and is not usually called directly from code.


/api/v2/video/watchkey

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/watchkey"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.watchKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#watchKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MediaApi;

public class MediaApiExample {
    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.watchKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#watchKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
MediaApi *apiInstance = [[MediaApi alloc] init];

// Watch Key
[apiInstance watchKeyWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.MediaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.watchKey(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class watchKeyExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new MediaApi();

            try {
                // Watch Key
                oas_any_type_not_mapped result = apiInstance.watchKey();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MediaApi.watchKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MediaApi();

try {
    $result = $api_instance->watchKey();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->watchKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MediaApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MediaApi->new();

eval { 
    my $result = $api_instance->watchKey();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->watchKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MediaApi()

try: 
    # Watch Key
    api_response = api_instance.watch_key()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->watchKey: %s\n" % e)
extern crate MediaApi;

pub fn main() {

    let mut context = MediaApi::Context::default();
    let result = client.watchKey(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Moderation

banUserV2

Ban User

TODO


/api/v2/moderation/user/ban

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/moderation/user/ban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.banUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#banUserV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.banUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#banUserV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Ban User
[apiInstance banUserV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.banUserV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class banUserV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Ban User
                oas_any_type_not_mapped result = apiInstance.banUserV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.banUserV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->banUserV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->banUserV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->banUserV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->banUserV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Ban User
    api_response = api_instance.ban_user_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->banUserV2: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.banUserV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


banUserV3

Ban User

TODO


/api/v3/moderation/user/ban

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/moderation/user/ban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.banUserV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#banUserV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.banUserV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#banUserV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Ban User
[apiInstance banUserV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.banUserV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class banUserV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Ban User
                oas_any_type_not_mapped result = apiInstance.banUserV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.banUserV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->banUserV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->banUserV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->banUserV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->banUserV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Ban User
    api_response = api_instance.ban_user_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->banUserV3: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.banUserV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


hideCommentV2

Hide Comment

TODO


/api/v2/moderation/comment/hide

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/moderation/comment/hide"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.hideCommentV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#hideCommentV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.hideCommentV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#hideCommentV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Hide Comment
[apiInstance hideCommentV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.hideCommentV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class hideCommentV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Hide Comment
                oas_any_type_not_mapped result = apiInstance.hideCommentV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.hideCommentV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->hideCommentV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->hideCommentV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->hideCommentV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->hideCommentV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Hide Comment
    api_response = api_instance.hide_comment_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->hideCommentV2: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.hideCommentV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


hideCommentV3

Hide Comment

TODO


/api/v3/moderation/comment/hide

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/moderation/comment/hide"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.hideCommentV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#hideCommentV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.hideCommentV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#hideCommentV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Hide Comment
[apiInstance hideCommentV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.hideCommentV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class hideCommentV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Hide Comment
                oas_any_type_not_mapped result = apiInstance.hideCommentV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.hideCommentV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->hideCommentV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->hideCommentV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->hideCommentV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->hideCommentV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Hide Comment
    api_response = api_instance.hide_comment_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->hideCommentV3: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.hideCommentV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listBanV2

List Ban

TODO


/api/v2/moderation/user/ban/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/moderation/user/ban/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listBanV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#listBanV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listBanV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#listBanV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// List Ban
[apiInstance listBanV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listBanV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listBanV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // List Ban
                oas_any_type_not_mapped result = apiInstance.listBanV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.listBanV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->listBanV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->listBanV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->listBanV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->listBanV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # List Ban
    api_response = api_instance.list_ban_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->listBanV2: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.listBanV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listBanV3

List Ban

TODO


/api/v3/moderation/user/ban/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/moderation/user/ban/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listBanV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#listBanV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listBanV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#listBanV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// List Ban
[apiInstance listBanV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listBanV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listBanV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // List Ban
                oas_any_type_not_mapped result = apiInstance.listBanV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.listBanV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->listBanV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->listBanV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->listBanV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->listBanV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # List Ban
    api_response = api_instance.list_ban_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->listBanV3: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.listBanV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


moderateComment

Moderate Comment

TODO


/api/v3/comment/moderate/

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/comment/moderate/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.moderateComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#moderateComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.moderateComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#moderateComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Moderate Comment
[apiInstance moderateCommentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moderateComment(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class moderateCommentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Moderate Comment
                oas_any_type_not_mapped result = apiInstance.moderateComment();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.moderateComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->moderateComment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->moderateComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->moderateComment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->moderateComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Moderate Comment
    api_response = api_instance.moderate_comment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->moderateComment: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.moderateComment(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


moderateVideoComment

Moderate Video Comment

TODO


/api/v2/comment/moderate/

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/comment/moderate/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.moderateVideoComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#moderateVideoComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.moderateVideoComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#moderateVideoComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Moderate Video Comment
[apiInstance moderateVideoCommentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moderateVideoComment(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class moderateVideoCommentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Moderate Video Comment
                oas_any_type_not_mapped result = apiInstance.moderateVideoComment();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.moderateVideoComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->moderateVideoComment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->moderateVideoComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->moderateVideoComment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->moderateVideoComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Moderate Video Comment
    api_response = api_instance.moderate_video_comment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->moderateVideoComment: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.moderateVideoComment(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


unbanUserV2

Unban User

TODO


/api/v2/moderation/user/unban

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/moderation/user/unban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unbanUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#unbanUserV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unbanUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#unbanUserV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Unban User
[apiInstance unbanUserV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unbanUserV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unbanUserV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Unban User
                oas_any_type_not_mapped result = apiInstance.unbanUserV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.unbanUserV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->unbanUserV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->unbanUserV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->unbanUserV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->unbanUserV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Unban User
    api_response = api_instance.unban_user_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->unbanUserV2: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.unbanUserV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


unbanUserV3

Unban User

TODO


/api/v3/moderation/user/unban

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/moderation/user/unban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unbanUserV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#unbanUserV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unbanUserV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#unbanUserV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Unban User
[apiInstance unbanUserV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unbanUserV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unbanUserV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Unban User
                oas_any_type_not_mapped result = apiInstance.unbanUserV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.unbanUserV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->unbanUserV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->unbanUserV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->unbanUserV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->unbanUserV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Unban User
    api_response = api_instance.unban_user_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->unbanUserV3: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.unbanUserV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


unhideCommentV2

Unhide Comment

TODO


/api/v2/moderation/comment/unhide

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/moderation/comment/unhide"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unhideCommentV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#unhideCommentV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unhideCommentV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#unhideCommentV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Unhide Comment
[apiInstance unhideCommentV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unhideCommentV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unhideCommentV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Unhide Comment
                oas_any_type_not_mapped result = apiInstance.unhideCommentV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.unhideCommentV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->unhideCommentV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->unhideCommentV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->unhideCommentV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->unhideCommentV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Unhide Comment
    api_response = api_instance.unhide_comment_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->unhideCommentV2: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.unhideCommentV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


unhideCommentV3

Unhide Comment

TODO


/api/v3/moderation/comment/unhide

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/moderation/comment/unhide"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unhideCommentV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#unhideCommentV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unhideCommentV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#unhideCommentV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// Unhide Comment
[apiInstance unhideCommentV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unhideCommentV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unhideCommentV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // Unhide Comment
                oas_any_type_not_mapped result = apiInstance.unhideCommentV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.unhideCommentV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->unhideCommentV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->unhideCommentV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->unhideCommentV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->unhideCommentV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # Unhide Comment
    api_response = api_instance.unhide_comment_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->unhideCommentV3: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.unhideCommentV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


userBanStatusV2

User Ban Status

TODO


/api/v2/moderator/userBanStatus

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/moderator/userBanStatus"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userBanStatusV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userBanStatusV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userBanStatusV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userBanStatusV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// User Ban Status
[apiInstance userBanStatusV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userBanStatusV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userBanStatusV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // User Ban Status
                oas_any_type_not_mapped result = apiInstance.userBanStatusV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.userBanStatusV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->userBanStatusV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->userBanStatusV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->userBanStatusV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->userBanStatusV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # User Ban Status
    api_response = api_instance.user_ban_status_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->userBanStatusV2: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.userBanStatusV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


userBanStatusV3

User Ban Status

TODO


/api/v3/moderator/userBanStatus

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/moderator/userBanStatus"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userBanStatusV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userBanStatusV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userBanStatusV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userBanStatusV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// User Ban Status
[apiInstance userBanStatusV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userBanStatusV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userBanStatusV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // User Ban Status
                oas_any_type_not_mapped result = apiInstance.userBanStatusV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.userBanStatusV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->userBanStatusV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->userBanStatusV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->userBanStatusV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->userBanStatusV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # User Ban Status
    api_response = api_instance.user_ban_status_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->userBanStatusV3: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.userBanStatusV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


userInfoV2

User Info

TODO


/api/v2/moderation/user/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/moderation/user/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userInfoV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userInfoV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userInfoV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userInfoV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// User Info
[apiInstance userInfoV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userInfoV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userInfoV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // User Info
                oas_any_type_not_mapped result = apiInstance.userInfoV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.userInfoV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->userInfoV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->userInfoV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->userInfoV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->userInfoV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # User Info
    api_response = api_instance.user_info_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->userInfoV2: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.userInfoV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


userInfoV3

User Info

TODO


/api/v3/moderation/user/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/moderation/user/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userInfoV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userInfoV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userInfoV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userInfoV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// User Info
[apiInstance userInfoV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userInfoV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userInfoV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // User Info
                oas_any_type_not_mapped result = apiInstance.userInfoV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.userInfoV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->userInfoV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->userInfoV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->userInfoV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->userInfoV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # User Info
    api_response = api_instance.user_info_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->userInfoV3: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.userInfoV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


userUnbanV2

User Unban

TODO


/api/v2/moderator/user/unban

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/moderator/user/unban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userUnbanV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userUnbanV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userUnbanV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userUnbanV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// User Unban
[apiInstance userUnbanV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userUnbanV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userUnbanV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // User Unban
                oas_any_type_not_mapped result = apiInstance.userUnbanV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.userUnbanV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->userUnbanV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->userUnbanV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->userUnbanV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->userUnbanV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # User Unban
    api_response = api_instance.user_unban_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->userUnbanV2: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.userUnbanV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


userUnbanV3

User Unban

TODO


/api/v3/moderator/user/unban

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/moderator/user/unban"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ModerationApi;

import java.io.File;
import java.util.*;

public class ModerationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userUnbanV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userUnbanV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ModerationApi;

public class ModerationApiExample {
    public static void main(String[] args) {
        ModerationApi apiInstance = new ModerationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.userUnbanV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModerationApi#userUnbanV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ModerationApi *apiInstance = [[ModerationApi alloc] init];

// User Unban
[apiInstance userUnbanV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ModerationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userUnbanV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userUnbanV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ModerationApi();

            try {
                // User Unban
                oas_any_type_not_mapped result = apiInstance.userUnbanV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ModerationApi.userUnbanV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ModerationApi();

try {
    $result = $api_instance->userUnbanV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->userUnbanV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ModerationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ModerationApi->new();

eval { 
    my $result = $api_instance->userUnbanV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModerationApi->userUnbanV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ModerationApi()

try: 
    # User Unban
    api_response = api_instance.user_unban_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModerationApi->userUnbanV3: %s\n" % e)
extern crate ModerationApi;

pub fn main() {

    let mut context = ModerationApi::Context::default();
    let result = client.userUnbanV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


PasswordReset

resetPassword

Reset Password

TODO


/api/v2/user/password/reset

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/password/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordResetApi;

import java.io.File;
import java.util.*;

public class PasswordResetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PasswordResetApi apiInstance = new PasswordResetApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.resetPassword();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetApi#resetPassword");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PasswordResetApi;

public class PasswordResetApiExample {
    public static void main(String[] args) {
        PasswordResetApi apiInstance = new PasswordResetApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.resetPassword();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetApi#resetPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PasswordResetApi *apiInstance = [[PasswordResetApi alloc] init];

// Reset Password
[apiInstance resetPasswordWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PasswordResetApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resetPassword(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class resetPasswordExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PasswordResetApi();

            try {
                // Reset Password
                oas_any_type_not_mapped result = apiInstance.resetPassword();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordResetApi.resetPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordResetApi();

try {
    $result = $api_instance->resetPassword();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PasswordResetApi->resetPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PasswordResetApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordResetApi->new();

eval { 
    my $result = $api_instance->resetPassword();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordResetApi->resetPassword: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PasswordResetApi()

try: 
    # Reset Password
    api_response = api_instance.reset_password()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordResetApi->resetPassword: %s\n" % e)
extern crate PasswordResetApi;

pub fn main() {

    let mut context = PasswordResetApi::Context::default();
    let result = client.resetPassword(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


sendPasswordReset

Send Password Reset

TODO


/api/v2/user/password/reset/request

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/password/reset/request"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordResetApi;

import java.io.File;
import java.util.*;

public class PasswordResetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PasswordResetApi apiInstance = new PasswordResetApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.sendPasswordReset();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetApi#sendPasswordReset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PasswordResetApi;

public class PasswordResetApiExample {
    public static void main(String[] args) {
        PasswordResetApi apiInstance = new PasswordResetApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.sendPasswordReset();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetApi#sendPasswordReset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PasswordResetApi *apiInstance = [[PasswordResetApi alloc] init];

// Send Password Reset
[apiInstance sendPasswordResetWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PasswordResetApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendPasswordReset(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class sendPasswordResetExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PasswordResetApi();

            try {
                // Send Password Reset
                oas_any_type_not_mapped result = apiInstance.sendPasswordReset();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordResetApi.sendPasswordReset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordResetApi();

try {
    $result = $api_instance->sendPasswordReset();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PasswordResetApi->sendPasswordReset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PasswordResetApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordResetApi->new();

eval { 
    my $result = $api_instance->sendPasswordReset();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordResetApi->sendPasswordReset: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PasswordResetApi()

try: 
    # Send Password Reset
    api_response = api_instance.send_password_reset()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordResetApi->sendPasswordReset: %s\n" % e)
extern crate PasswordResetApi;

pub fn main() {

    let mut context = PasswordResetApi::Context::default();
    let result = client.sendPasswordReset(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


validateKey

Validate Key

TODO


/api/v2/user/password/reset/validate

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/password/reset/validate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PasswordResetApi;

import java.io.File;
import java.util.*;

public class PasswordResetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PasswordResetApi apiInstance = new PasswordResetApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.validateKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetApi#validateKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PasswordResetApi;

public class PasswordResetApiExample {
    public static void main(String[] args) {
        PasswordResetApi apiInstance = new PasswordResetApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.validateKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PasswordResetApi#validateKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PasswordResetApi *apiInstance = [[PasswordResetApi alloc] init];

// Validate Key
[apiInstance validateKeyWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PasswordResetApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateKey(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class validateKeyExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PasswordResetApi();

            try {
                // Validate Key
                oas_any_type_not_mapped result = apiInstance.validateKey();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PasswordResetApi.validateKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PasswordResetApi();

try {
    $result = $api_instance->validateKey();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PasswordResetApi->validateKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PasswordResetApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PasswordResetApi->new();

eval { 
    my $result = $api_instance->validateKey();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PasswordResetApi->validateKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PasswordResetApi()

try: 
    # Validate Key
    api_response = api_instance.validate_key()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PasswordResetApi->validateKey: %s\n" % e)
extern crate PasswordResetApi;

pub fn main() {

    let mut context = PasswordResetApi::Context::default();
    let result = client.validateKey(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Payments

addAddress

Add Address

TODO


/api/v2/payment/address/add

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/address/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#addAddress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#addAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Add Address
[apiInstance addAddressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAddress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addAddressExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Add Address
                oas_any_type_not_mapped result = apiInstance.addAddress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.addAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->addAddress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->addAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->addAddress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->addAddress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Add Address
    api_response = api_instance.add_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->addAddress: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.addAddress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


addPaymentMethod

Add Payment Method

TODO


/api/v2/payment/method/add

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/method/add"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addPaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#addPaymentMethod");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addPaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#addPaymentMethod");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Add Payment Method
[apiInstance addPaymentMethodWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addPaymentMethod(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addPaymentMethodExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Add Payment Method
                oas_any_type_not_mapped result = apiInstance.addPaymentMethod();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.addPaymentMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->addPaymentMethod();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->addPaymentMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->addPaymentMethod();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->addPaymentMethod: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Add Payment Method
    api_response = api_instance.add_payment_method()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->addPaymentMethod: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.addPaymentMethod(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


cancelSubscription

Cancel Subscription

TODO


/api/v2/payment/subscription/cancel

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/subscription/cancel"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.cancelSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#cancelSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.cancelSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#cancelSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Cancel Subscription
[apiInstance cancelSubscriptionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cancelSubscription(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class cancelSubscriptionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Cancel Subscription
                oas_any_type_not_mapped result = apiInstance.cancelSubscription();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.cancelSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->cancelSubscription();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->cancelSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->cancelSubscription();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->cancelSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Cancel Subscription
    api_response = api_instance.cancel_subscription()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->cancelSubscription: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.cancelSubscription(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


deleteAddress

Delete Address

TODO


/api/v2/payment/address/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/address/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#deleteAddress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deleteAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#deleteAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Delete Address
[apiInstance deleteAddressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAddress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteAddressExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Delete Address
                oas_any_type_not_mapped result = apiInstance.deleteAddress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.deleteAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->deleteAddress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->deleteAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->deleteAddress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->deleteAddress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Delete Address
    api_response = api_instance.delete_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->deleteAddress: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.deleteAddress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


deletePaymentMethod

Delete Payment Method

TODO


/api/v2/payment/method/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/method/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deletePaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#deletePaymentMethod");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deletePaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#deletePaymentMethod");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Delete Payment Method
[apiInstance deletePaymentMethodWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePaymentMethod(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deletePaymentMethodExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Delete Payment Method
                oas_any_type_not_mapped result = apiInstance.deletePaymentMethod();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.deletePaymentMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->deletePaymentMethod();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->deletePaymentMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->deletePaymentMethod();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->deletePaymentMethod: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Delete Payment Method
    api_response = api_instance.delete_payment_method()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->deletePaymentMethod: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.deletePaymentMethod(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


estimateTaxes

Estimate Taxes

TODO


/api/v2/payment/tax/estimate

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/tax/estimate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.estimateTaxes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#estimateTaxes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.estimateTaxes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#estimateTaxes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Estimate Taxes
[apiInstance estimateTaxesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.estimateTaxes(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class estimateTaxesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Estimate Taxes
                oas_any_type_not_mapped result = apiInstance.estimateTaxes();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.estimateTaxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->estimateTaxes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->estimateTaxes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->estimateTaxes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->estimateTaxes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Estimate Taxes
    api_response = api_instance.estimate_taxes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->estimateTaxes: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.estimateTaxes(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listAddresses

List Addresses

Retrieve a list of billing addresses saved to the user's account, to be used in conjunction with a payment method when purchasing subscriptions to creators.


/api/v2/payment/address/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/address/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            array[PaymentAddressModel] result = apiInstance.listAddresses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#listAddresses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            array[PaymentAddressModel] result = apiInstance.listAddresses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#listAddresses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// List Addresses
[apiInstance listAddressesWithCompletionHandler: 
              ^(array[PaymentAddressModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAddresses(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listAddressesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // List Addresses
                array[PaymentAddressModel] result = apiInstance.listAddresses();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.listAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->listAddresses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->listAddresses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->listAddresses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->listAddresses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # List Addresses
    api_response = api_instance.list_addresses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->listAddresses: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.listAddresses(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listInvoices

List Invoices

Retrieve a list of paid or unpaid subscription invoices for the user.


/api/v2/payment/invoice/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/invoice/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            PaymentInvoiceListV2Response result = apiInstance.listInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#listInvoices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            PaymentInvoiceListV2Response result = apiInstance.listInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#listInvoices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// List Invoices
[apiInstance listInvoicesWithCompletionHandler: 
              ^(PaymentInvoiceListV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listInvoices(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listInvoicesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // List Invoices
                PaymentInvoiceListV2Response result = apiInstance.listInvoices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.listInvoices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->listInvoices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->listInvoices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->listInvoices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->listInvoices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # List Invoices
    api_response = api_instance.list_invoices()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->listInvoices: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.listInvoices(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listPaymentMethods

List Payment Methods

Retrieve a list of saved payment methods for the user's account. Payment methods are how the user can pay for their subscription to creators on the platform.


/api/v2/payment/method/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/method/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            array[PaymentMethodModel] result = apiInstance.listPaymentMethods();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#listPaymentMethods");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            array[PaymentMethodModel] result = apiInstance.listPaymentMethods();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#listPaymentMethods");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// List Payment Methods
[apiInstance listPaymentMethodsWithCompletionHandler: 
              ^(array[PaymentMethodModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPaymentMethods(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listPaymentMethodsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // List Payment Methods
                array[PaymentMethodModel] result = apiInstance.listPaymentMethods();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.listPaymentMethods: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->listPaymentMethods();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->listPaymentMethods: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->listPaymentMethods();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->listPaymentMethods: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # List Payment Methods
    api_response = api_instance.list_payment_methods()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->listPaymentMethods: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.listPaymentMethods(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


purchaseSubscription

Purchase Subscription

TODO


/api/v2/payment/subscription/purchase

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/subscription/purchase"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.purchaseSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#purchaseSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.purchaseSubscription();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#purchaseSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Purchase Subscription
[apiInstance purchaseSubscriptionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.purchaseSubscription(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class purchaseSubscriptionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Purchase Subscription
                oas_any_type_not_mapped result = apiInstance.purchaseSubscription();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.purchaseSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->purchaseSubscription();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->purchaseSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->purchaseSubscription();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->purchaseSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Purchase Subscription
    api_response = api_instance.purchase_subscription()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->purchaseSubscription: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.purchaseSubscription(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


setPrimaryAddress

Set Primary Address

TODO


/api/v2/payment/address/set

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/address/set"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.setPrimaryAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#setPrimaryAddress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.setPrimaryAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#setPrimaryAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Set Primary Address
[apiInstance setPrimaryAddressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setPrimaryAddress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class setPrimaryAddressExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Set Primary Address
                oas_any_type_not_mapped result = apiInstance.setPrimaryAddress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.setPrimaryAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->setPrimaryAddress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->setPrimaryAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->setPrimaryAddress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->setPrimaryAddress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Set Primary Address
    api_response = api_instance.set_primary_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->setPrimaryAddress: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.setPrimaryAddress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


setPrimaryPaymentMethod

Set Primary Payment Method

TODO


/api/v2/payment/method/set

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/method/set"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.setPrimaryPaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#setPrimaryPaymentMethod");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.setPrimaryPaymentMethod();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#setPrimaryPaymentMethod");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Set Primary Payment Method
[apiInstance setPrimaryPaymentMethodWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setPrimaryPaymentMethod(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class setPrimaryPaymentMethodExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Set Primary Payment Method
                oas_any_type_not_mapped result = apiInstance.setPrimaryPaymentMethod();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.setPrimaryPaymentMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->setPrimaryPaymentMethod();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->setPrimaryPaymentMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->setPrimaryPaymentMethod();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->setPrimaryPaymentMethod: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Set Primary Payment Method
    api_response = api_instance.set_primary_payment_method()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->setPrimaryPaymentMethod: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.setPrimaryPaymentMethod(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateAddress

Update Address

TODO


/api/v2/payment/address/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/address/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#updateAddress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#updateAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];

// Update Address
[apiInstance updateAddressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAddress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateAddressExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();

            try {
                // Update Address
                oas_any_type_not_mapped result = apiInstance.updateAddress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.updateAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();

try {
    $result = $api_instance->updateAddress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->updateAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();

eval { 
    my $result = $api_instance->updateAddress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->updateAddress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()

try: 
    # Update Address
    api_response = api_instance.update_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->updateAddress: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {

    let mut context = PaymentsApi::Context::default();
    let result = client.updateAddress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


webhook

Webhook

TODO


/api/v2/payment/webhook/{paymentProcessor}

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/webhook/{paymentProcessor}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        String paymentProcessor = paymentProcessor_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.webhook(paymentProcessor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#webhook");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        String paymentProcessor = paymentProcessor_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.webhook(paymentProcessor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#webhook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];
String *paymentProcessor = paymentProcessor_example; //  (default to null)

// Webhook
[apiInstance webhookWith:paymentProcessor
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var paymentProcessor = paymentProcessor_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webhook(paymentProcessor, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class webhookExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();
            var paymentProcessor = paymentProcessor_example;  // String |  (default to null)

            try {
                // Webhook
                oas_any_type_not_mapped result = apiInstance.webhook(paymentProcessor);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.webhook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();
$paymentProcessor = paymentProcessor_example; // String | 

try {
    $result = $api_instance->webhook($paymentProcessor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->webhook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();
my $paymentProcessor = paymentProcessor_example; # String | 

eval { 
    my $result = $api_instance->webhook(paymentProcessor => $paymentProcessor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->webhook: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()
paymentProcessor = paymentProcessor_example # String |  (default to null)

try: 
    # Webhook
    api_response = api_instance.webhook(paymentProcessor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->webhook: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {
    let paymentProcessor = paymentProcessor_example; // String

    let mut context = PaymentsApi::Context::default();
    let result = client.webhook(paymentProcessor, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
paymentProcessor*
String
Required

Responses


webhookWithSubprocessor

Webhook With Subprocessor

TODO


/api/v2/payment/webhook/{paymentProcessor}/{subPaymentProcessor}

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/webhook/{paymentProcessor}/{subPaymentProcessor}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsApi;

import java.io.File;
import java.util.*;

public class PaymentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PaymentsApi apiInstance = new PaymentsApi();
        String paymentProcessor = paymentProcessor_example; // String | 
        String subPaymentProcessor = subPaymentProcessor_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#webhookWithSubprocessor");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsApi;

public class PaymentsApiExample {
    public static void main(String[] args) {
        PaymentsApi apiInstance = new PaymentsApi();
        String paymentProcessor = paymentProcessor_example; // String | 
        String subPaymentProcessor = subPaymentProcessor_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsApi#webhookWithSubprocessor");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsApi *apiInstance = [[PaymentsApi alloc] init];
String *paymentProcessor = paymentProcessor_example; //  (default to null)
String *subPaymentProcessor = subPaymentProcessor_example; //  (default to null)

// Webhook With Subprocessor
[apiInstance webhookWithSubprocessorWith:paymentProcessor
    subPaymentProcessor:subPaymentProcessor
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PaymentsApi()
var paymentProcessor = paymentProcessor_example; // {String} 
var subPaymentProcessor = subPaymentProcessor_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class webhookWithSubprocessorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PaymentsApi();
            var paymentProcessor = paymentProcessor_example;  // String |  (default to null)
            var subPaymentProcessor = subPaymentProcessor_example;  // String |  (default to null)

            try {
                // Webhook With Subprocessor
                oas_any_type_not_mapped result = apiInstance.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsApi.webhookWithSubprocessor: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsApi();
$paymentProcessor = paymentProcessor_example; // String | 
$subPaymentProcessor = subPaymentProcessor_example; // String | 

try {
    $result = $api_instance->webhookWithSubprocessor($paymentProcessor, $subPaymentProcessor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->webhookWithSubprocessor: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsApi->new();
my $paymentProcessor = paymentProcessor_example; # String | 
my $subPaymentProcessor = subPaymentProcessor_example; # String | 

eval { 
    my $result = $api_instance->webhookWithSubprocessor(paymentProcessor => $paymentProcessor, subPaymentProcessor => $subPaymentProcessor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsApi->webhookWithSubprocessor: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsApi()
paymentProcessor = paymentProcessor_example # String |  (default to null)
subPaymentProcessor = subPaymentProcessor_example # String |  (default to null)

try: 
    # Webhook With Subprocessor
    api_response = api_instance.webhook_with_subprocessor(paymentProcessor, subPaymentProcessor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsApi->webhookWithSubprocessor: %s\n" % e)
extern crate PaymentsApi;

pub fn main() {
    let paymentProcessor = paymentProcessor_example; // String
    let subPaymentProcessor = subPaymentProcessor_example; // String

    let mut context = PaymentsApi::Context::default();
    let result = client.webhookWithSubprocessor(paymentProcessor, subPaymentProcessor, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
paymentProcessor*
String
Required
subPaymentProcessor*
String
Required

Responses


Playlist

listPlaylistVideos

List Videos

TODO


/api/v2/playlist/videos

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/playlist/videos"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlaylistApi;

import java.io.File;
import java.util.*;

public class PlaylistApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        PlaylistApi apiInstance = new PlaylistApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listPlaylistVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#listPlaylistVideos");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PlaylistApi;

public class PlaylistApiExample {
    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listPlaylistVideos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#listPlaylistVideos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PlaylistApi *apiInstance = [[PlaylistApi alloc] init];

// List Videos
[apiInstance listPlaylistVideosWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.PlaylistApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPlaylistVideos(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listPlaylistVideosExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new PlaylistApi();

            try {
                // List Videos
                oas_any_type_not_mapped result = apiInstance.listPlaylistVideos();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlaylistApi.listPlaylistVideos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlaylistApi();

try {
    $result = $api_instance->listPlaylistVideos();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->listPlaylistVideos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PlaylistApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlaylistApi->new();

eval { 
    my $result = $api_instance->listPlaylistVideos();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlaylistApi->listPlaylistVideos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PlaylistApi()

try: 
    # List Videos
    api_response = api_instance.list_playlist_videos()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaylistApi->listPlaylistVideos: %s\n" % e)
extern crate PlaylistApi;

pub fn main() {

    let mut context = PlaylistApi::Context::default();
    let result = client.listPlaylistVideos(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Socket

disconnectSocket

Disconnect

TODO


/api/v3/socket/disconnect

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/socket/disconnect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketApi;

import java.io.File;
import java.util.*;

public class SocketApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SocketApi apiInstance = new SocketApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSocket();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketApi#disconnectSocket");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketApi;

public class SocketApiExample {
    public static void main(String[] args) {
        SocketApi apiInstance = new SocketApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSocket();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketApi#disconnectSocket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SocketApi *apiInstance = [[SocketApi alloc] init];

// Disconnect
[apiInstance disconnectSocketWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SocketApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disconnectSocket(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class disconnectSocketExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SocketApi();

            try {
                // Disconnect
                oas_any_type_not_mapped result = apiInstance.disconnectSocket();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketApi.disconnectSocket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketApi();

try {
    $result = $api_instance->disconnectSocket();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketApi->disconnectSocket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketApi->new();

eval { 
    my $result = $api_instance->disconnectSocket();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketApi->disconnectSocket: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketApi()

try: 
    # Disconnect
    api_response = api_instance.disconnect_socket()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketApi->disconnectSocket: %s\n" % e)
extern crate SocketApi;

pub fn main() {

    let mut context = SocketApi::Context::default();
    let result = client.disconnectSocket(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


socketConnect

Connect

TODO


/api/v3/socket/connect

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/socket/connect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketApi;

import java.io.File;
import java.util.*;

public class SocketApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SocketApi apiInstance = new SocketApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.socketConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketApi#socketConnect");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketApi;

public class SocketApiExample {
    public static void main(String[] args) {
        SocketApi apiInstance = new SocketApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.socketConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketApi#socketConnect");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SocketApi *apiInstance = [[SocketApi alloc] init];

// Connect
[apiInstance socketConnectWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SocketApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.socketConnect(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class socketConnectExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SocketApi();

            try {
                // Connect
                oas_any_type_not_mapped result = apiInstance.socketConnect();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketApi.socketConnect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketApi();

try {
    $result = $api_instance->socketConnect();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketApi->socketConnect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketApi->new();

eval { 
    my $result = $api_instance->socketConnect();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketApi->socketConnect: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketApi()

try: 
    # Connect
    api_response = api_instance.socket_connect()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketApi->socketConnect: %s\n" % e)
extern crate SocketApi;

pub fn main() {

    let mut context = SocketApi::Context::default();
    let result = client.socketConnect(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


subscribeUser

Subscribe User

TODO


/api/v2/socket/subscribe/user

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/socket/subscribe/user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketApi;

import java.io.File;
import java.util.*;

public class SocketApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SocketApi apiInstance = new SocketApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.subscribeUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketApi#subscribeUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketApi;

public class SocketApiExample {
    public static void main(String[] args) {
        SocketApi apiInstance = new SocketApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.subscribeUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketApi#subscribeUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SocketApi *apiInstance = [[SocketApi alloc] init];

// Subscribe User
[apiInstance subscribeUserWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SocketApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subscribeUser(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class subscribeUserExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SocketApi();

            try {
                // Subscribe User
                oas_any_type_not_mapped result = apiInstance.subscribeUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketApi.subscribeUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketApi();

try {
    $result = $api_instance->subscribeUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketApi->subscribeUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketApi->new();

eval { 
    my $result = $api_instance->subscribeUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketApi->subscribeUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketApi()

try: 
    # Subscribe User
    api_response = api_instance.subscribe_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketApi->subscribeUser: %s\n" % e)
extern crate SocketApi;

pub fn main() {

    let mut context = SocketApi::Context::default();
    let result = client.subscribeUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


subscribeUserById

Subscribe User By Id

TODO


/api/v2/socket/subscribe/user/{id}

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/socket/subscribe/user/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketApi;

import java.io.File;
import java.util.*;

public class SocketApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SocketApi apiInstance = new SocketApi();
        String id = id_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.subscribeUserById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketApi#subscribeUserById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketApi;

public class SocketApiExample {
    public static void main(String[] args) {
        SocketApi apiInstance = new SocketApi();
        String id = id_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.subscribeUserById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketApi#subscribeUserById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SocketApi *apiInstance = [[SocketApi alloc] init];
String *id = id_example; //  (default to null)

// Subscribe User By Id
[apiInstance subscribeUserByIdWith:id
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SocketApi()
var id = id_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subscribeUserById(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class subscribeUserByIdExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SocketApi();
            var id = id_example;  // String |  (default to null)

            try {
                // Subscribe User By Id
                oas_any_type_not_mapped result = apiInstance.subscribeUserById(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketApi.subscribeUserById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketApi();
$id = id_example; // String | 

try {
    $result = $api_instance->subscribeUserById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketApi->subscribeUserById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->subscribeUserById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketApi->subscribeUserById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketApi()
id = id_example # String |  (default to null)

try: 
    # Subscribe User By Id
    api_response = api_instance.subscribe_user_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketApi->subscribeUserById: %s\n" % e)
extern crate SocketApi;

pub fn main() {
    let id = id_example; // String

    let mut context = SocketApi::Context::default();
    let result = client.subscribeUserById(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Required

Responses


Stripe

retrievePublicKey

Retrieve Public Key

TODO


/api/v2/payment/stripe/pk

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/payment/stripe/pk"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StripeApi;

import java.io.File;
import java.util.*;

public class StripeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        StripeApi apiInstance = new StripeApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.retrievePublicKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripeApi#retrievePublicKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StripeApi;

public class StripeApiExample {
    public static void main(String[] args) {
        StripeApi apiInstance = new StripeApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.retrievePublicKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripeApi#retrievePublicKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
StripeApi *apiInstance = [[StripeApi alloc] init];

// Retrieve Public Key
[apiInstance retrievePublicKeyWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.StripeApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrievePublicKey(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class retrievePublicKeyExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new StripeApi();

            try {
                // Retrieve Public Key
                oas_any_type_not_mapped result = apiInstance.retrievePublicKey();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StripeApi.retrievePublicKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StripeApi();

try {
    $result = $api_instance->retrievePublicKey();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StripeApi->retrievePublicKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StripeApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StripeApi->new();

eval { 
    my $result = $api_instance->retrievePublicKey();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StripeApi->retrievePublicKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.StripeApi()

try: 
    # Retrieve Public Key
    api_response = api_instance.retrieve_public_key()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StripeApi->retrievePublicKey: %s\n" % e)
extern crate StripeApi;

pub fn main() {

    let mut context = StripeApi::Context::default();
    let result = client.retrievePublicKey(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Subscriptions

doesUserHaveSubV2

Does User Have Sub

TODO


/api/v2/user/subscribed

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/subscribed"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriptionsApi;

import java.io.File;
import java.util.*;

public class SubscriptionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SubscriptionsApi apiInstance = new SubscriptionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsApi#doesUserHaveSubV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriptionsApi;

public class SubscriptionsApiExample {
    public static void main(String[] args) {
        SubscriptionsApi apiInstance = new SubscriptionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsApi#doesUserHaveSubV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SubscriptionsApi *apiInstance = [[SubscriptionsApi alloc] init];

// Does User Have Sub
[apiInstance doesUserHaveSubV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SubscriptionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doesUserHaveSubV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class doesUserHaveSubV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SubscriptionsApi();

            try {
                // Does User Have Sub
                oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriptionsApi.doesUserHaveSubV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriptionsApi();

try {
    $result = $api_instance->doesUserHaveSubV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsApi->doesUserHaveSubV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriptionsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriptionsApi->new();

eval { 
    my $result = $api_instance->doesUserHaveSubV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionsApi->doesUserHaveSubV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SubscriptionsApi()

try: 
    # Does User Have Sub
    api_response = api_instance.does_user_have_sub_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionsApi->doesUserHaveSubV2: %s\n" % e)
extern crate SubscriptionsApi;

pub fn main() {

    let mut context = SubscriptionsApi::Context::default();
    let result = client.doesUserHaveSubV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


doesUserHaveSubV3

Does User Have Sub

TODO


/api/v3/user/subscribed

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/subscribed"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriptionsApi;

import java.io.File;
import java.util.*;

public class SubscriptionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SubscriptionsApi apiInstance = new SubscriptionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsApi#doesUserHaveSubV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriptionsApi;

public class SubscriptionsApiExample {
    public static void main(String[] args) {
        SubscriptionsApi apiInstance = new SubscriptionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsApi#doesUserHaveSubV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SubscriptionsApi *apiInstance = [[SubscriptionsApi alloc] init];

// Does User Have Sub
[apiInstance doesUserHaveSubV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SubscriptionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doesUserHaveSubV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class doesUserHaveSubV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SubscriptionsApi();

            try {
                // Does User Have Sub
                oas_any_type_not_mapped result = apiInstance.doesUserHaveSubV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriptionsApi.doesUserHaveSubV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriptionsApi();

try {
    $result = $api_instance->doesUserHaveSubV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsApi->doesUserHaveSubV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriptionsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriptionsApi->new();

eval { 
    my $result = $api_instance->doesUserHaveSubV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionsApi->doesUserHaveSubV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SubscriptionsApi()

try: 
    # Does User Have Sub
    api_response = api_instance.does_user_have_sub_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionsApi->doesUserHaveSubV3: %s\n" % e)
extern crate SubscriptionsApi;

pub fn main() {

    let mut context = SubscriptionsApi::Context::default();
    let result = client.doesUserHaveSubV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listUserSubscriptionsV2

List User Subscriptions

TODO


/api/v2/user/subscriptions

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/subscriptions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriptionsApi;

import java.io.File;
import java.util.*;

public class SubscriptionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SubscriptionsApi apiInstance = new SubscriptionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listUserSubscriptionsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsApi#listUserSubscriptionsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriptionsApi;

public class SubscriptionsApiExample {
    public static void main(String[] args) {
        SubscriptionsApi apiInstance = new SubscriptionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.listUserSubscriptionsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsApi#listUserSubscriptionsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SubscriptionsApi *apiInstance = [[SubscriptionsApi alloc] init];

// List User Subscriptions
[apiInstance listUserSubscriptionsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SubscriptionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUserSubscriptionsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listUserSubscriptionsV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SubscriptionsApi();

            try {
                // List User Subscriptions
                oas_any_type_not_mapped result = apiInstance.listUserSubscriptionsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriptionsApi.listUserSubscriptionsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriptionsApi();

try {
    $result = $api_instance->listUserSubscriptionsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsApi->listUserSubscriptionsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriptionsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriptionsApi->new();

eval { 
    my $result = $api_instance->listUserSubscriptionsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionsApi->listUserSubscriptionsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SubscriptionsApi()

try: 
    # List User Subscriptions
    api_response = api_instance.list_user_subscriptions_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionsApi->listUserSubscriptionsV2: %s\n" % e)
extern crate SubscriptionsApi;

pub fn main() {

    let mut context = SubscriptionsApi::Context::default();
    let result = client.listUserSubscriptionsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listUserSubscriptionsV3

List User Subscriptions

Retrieve a list of all active subscriptions for the user.


/api/v3/user/subscriptions

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/subscriptions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriptionsApi;

import java.io.File;
import java.util.*;

public class SubscriptionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SubscriptionsApi apiInstance = new SubscriptionsApi();
        
        try {
            array[UserSubscriptionModel] result = apiInstance.listUserSubscriptionsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsApi#listUserSubscriptionsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriptionsApi;

public class SubscriptionsApiExample {
    public static void main(String[] args) {
        SubscriptionsApi apiInstance = new SubscriptionsApi();
        
        try {
            array[UserSubscriptionModel] result = apiInstance.listUserSubscriptionsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsApi#listUserSubscriptionsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SubscriptionsApi *apiInstance = [[SubscriptionsApi alloc] init];

// List User Subscriptions
[apiInstance listUserSubscriptionsV3WithCompletionHandler: 
              ^(array[UserSubscriptionModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SubscriptionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUserSubscriptionsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listUserSubscriptionsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SubscriptionsApi();

            try {
                // List User Subscriptions
                array[UserSubscriptionModel] result = apiInstance.listUserSubscriptionsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriptionsApi.listUserSubscriptionsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriptionsApi();

try {
    $result = $api_instance->listUserSubscriptionsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsApi->listUserSubscriptionsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriptionsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriptionsApi->new();

eval { 
    my $result = $api_instance->listUserSubscriptionsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionsApi->listUserSubscriptionsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SubscriptionsApi()

try: 
    # List User Subscriptions
    api_response = api_instance.list_user_subscriptions_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionsApi->listUserSubscriptionsV3: %s\n" % e)
extern crate SubscriptionsApi;

pub fn main() {

    let mut context = SubscriptionsApi::Context::default();
    let result = client.listUserSubscriptionsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Support

getTicketTypes

Get Ticket Types

TODO


/api/v2/support/ticket/types

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/support/ticket/types"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SupportApi;

import java.io.File;
import java.util.*;

public class SupportApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SupportApi apiInstance = new SupportApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getTicketTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupportApi#getTicketTypes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SupportApi;

public class SupportApiExample {
    public static void main(String[] args) {
        SupportApi apiInstance = new SupportApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getTicketTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupportApi#getTicketTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SupportApi *apiInstance = [[SupportApi alloc] init];

// Get Ticket Types
[apiInstance getTicketTypesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SupportApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTicketTypes(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTicketTypesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SupportApi();

            try {
                // Get Ticket Types
                oas_any_type_not_mapped result = apiInstance.getTicketTypes();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SupportApi.getTicketTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SupportApi();

try {
    $result = $api_instance->getTicketTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SupportApi->getTicketTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SupportApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SupportApi->new();

eval { 
    my $result = $api_instance->getTicketTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SupportApi->getTicketTypes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SupportApi()

try: 
    # Get Ticket Types
    api_response = api_instance.get_ticket_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SupportApi->getTicketTypes: %s\n" % e)
extern crate SupportApi;

pub fn main() {

    let mut context = SupportApi::Context::default();
    let result = client.getTicketTypes(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


submitSupport

Submit Support

TODO


/api/v2/support/

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/support/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SupportApi;

import java.io.File;
import java.util.*;

public class SupportApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SupportApi apiInstance = new SupportApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.submitSupport();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupportApi#submitSupport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SupportApi;

public class SupportApiExample {
    public static void main(String[] args) {
        SupportApi apiInstance = new SupportApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.submitSupport();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupportApi#submitSupport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SupportApi *apiInstance = [[SupportApi alloc] init];

// Submit Support
[apiInstance submitSupportWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SupportApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.submitSupport(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class submitSupportExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SupportApi();

            try {
                // Submit Support
                oas_any_type_not_mapped result = apiInstance.submitSupport();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SupportApi.submitSupport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SupportApi();

try {
    $result = $api_instance->submitSupport();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SupportApi->submitSupport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SupportApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SupportApi->new();

eval { 
    my $result = $api_instance->submitSupport();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SupportApi->submitSupport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SupportApi()

try: 
    # Submit Support
    api_response = api_instance.submit_support()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SupportApi->submitSupport: %s\n" % e)
extern crate SupportApi;

pub fn main() {

    let mut context = SupportApi::Context::default();
    let result = client.submitSupport(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Sync

disconnectSync

Disconnect

TODO


/api/v2/sync/disconnect

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/sync/disconnect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SyncApi;

import java.io.File;
import java.util.*;

public class SyncApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SyncApi apiInstance = new SyncApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSync();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SyncApi#disconnectSync");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SyncApi;

public class SyncApiExample {
    public static void main(String[] args) {
        SyncApi apiInstance = new SyncApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSync();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SyncApi#disconnectSync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SyncApi *apiInstance = [[SyncApi alloc] init];

// Disconnect
[apiInstance disconnectSyncWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SyncApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disconnectSync(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class disconnectSyncExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SyncApi();

            try {
                // Disconnect
                oas_any_type_not_mapped result = apiInstance.disconnectSync();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SyncApi.disconnectSync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SyncApi();

try {
    $result = $api_instance->disconnectSync();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SyncApi->disconnectSync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SyncApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SyncApi->new();

eval { 
    my $result = $api_instance->disconnectSync();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SyncApi->disconnectSync: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SyncApi()

try: 
    # Disconnect
    api_response = api_instance.disconnect_sync()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SyncApi->disconnectSync: %s\n" % e)
extern crate SyncApi;

pub fn main() {

    let mut context = SyncApi::Context::default();
    let result = client.disconnectSync(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


syncConnect

Connect

TODO


/api/v2/sync/connect

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/sync/connect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SyncApi;

import java.io.File;
import java.util.*;

public class SyncApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SyncApi apiInstance = new SyncApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.syncConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SyncApi#syncConnect");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SyncApi;

public class SyncApiExample {
    public static void main(String[] args) {
        SyncApi apiInstance = new SyncApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.syncConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SyncApi#syncConnect");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SyncApi *apiInstance = [[SyncApi alloc] init];

// Connect
[apiInstance syncConnectWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.SyncApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.syncConnect(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class syncConnectExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SyncApi();

            try {
                // Connect
                oas_any_type_not_mapped result = apiInstance.syncConnect();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SyncApi.syncConnect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SyncApi();

try {
    $result = $api_instance->syncConnect();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SyncApi->syncConnect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SyncApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SyncApi->new();

eval { 
    my $result = $api_instance->syncConnect();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SyncApi->syncConnect: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SyncApi()

try: 
    # Connect
    api_response = api_instance.sync_connect()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SyncApi->syncConnect: %s\n" % e)
extern crate SyncApi;

pub fn main() {

    let mut context = SyncApi::Context::default();
    let result = client.syncConnect(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ThumbnailUpdateUnsubscribe

thumbnailUpdateUnsubscribe

Thumbnail Update Unsubscribe

TODO


/api/v3/content/thumbnail/unsubscribe

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/content/thumbnail/unsubscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ThumbnailUpdateUnsubscribeApi;

import java.io.File;
import java.util.*;

public class ThumbnailUpdateUnsubscribeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        ThumbnailUpdateUnsubscribeApi apiInstance = new ThumbnailUpdateUnsubscribeApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.thumbnailUpdateUnsubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThumbnailUpdateUnsubscribeApi#thumbnailUpdateUnsubscribe");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ThumbnailUpdateUnsubscribeApi;

public class ThumbnailUpdateUnsubscribeApiExample {
    public static void main(String[] args) {
        ThumbnailUpdateUnsubscribeApi apiInstance = new ThumbnailUpdateUnsubscribeApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.thumbnailUpdateUnsubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThumbnailUpdateUnsubscribeApi#thumbnailUpdateUnsubscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ThumbnailUpdateUnsubscribeApi *apiInstance = [[ThumbnailUpdateUnsubscribeApi alloc] init];

// Thumbnail Update Unsubscribe
[apiInstance thumbnailUpdateUnsubscribeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.ThumbnailUpdateUnsubscribeApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.thumbnailUpdateUnsubscribe(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class thumbnailUpdateUnsubscribeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new ThumbnailUpdateUnsubscribeApi();

            try {
                // Thumbnail Update Unsubscribe
                oas_any_type_not_mapped result = apiInstance.thumbnailUpdateUnsubscribe();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ThumbnailUpdateUnsubscribeApi.thumbnailUpdateUnsubscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ThumbnailUpdateUnsubscribeApi();

try {
    $result = $api_instance->thumbnailUpdateUnsubscribe();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ThumbnailUpdateUnsubscribeApi->thumbnailUpdateUnsubscribe: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ThumbnailUpdateUnsubscribeApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ThumbnailUpdateUnsubscribeApi->new();

eval { 
    my $result = $api_instance->thumbnailUpdateUnsubscribe();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ThumbnailUpdateUnsubscribeApi->thumbnailUpdateUnsubscribe: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ThumbnailUpdateUnsubscribeApi()

try: 
    # Thumbnail Update Unsubscribe
    api_response = api_instance.thumbnail_update_unsubscribe()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ThumbnailUpdateUnsubscribeApi->thumbnailUpdateUnsubscribe: %s\n" % e)
extern crate ThumbnailUpdateUnsubscribeApi;

pub fn main() {

    let mut context = ThumbnailUpdateUnsubscribeApi::Context::default();
    let result = client.thumbnailUpdateUnsubscribe(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Transcoding

getActiveProcesses

Get Active Processes

TODO


/api/cms/v3/processing/active

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/processing/active"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingApi;

import java.io.File;
import java.util.*;

public class TranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getActiveProcesses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#getActiveProcesses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingApi;

public class TranscodingApiExample {
    public static void main(String[] args) {
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getActiveProcesses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#getActiveProcesses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
TranscodingApi *apiInstance = [[TranscodingApi alloc] init];

// Get Active Processes
[apiInstance getActiveProcessesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.TranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActiveProcesses(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getActiveProcessesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TranscodingApi();

            try {
                // Get Active Processes
                oas_any_type_not_mapped result = apiInstance.getActiveProcesses();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingApi.getActiveProcesses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingApi();

try {
    $result = $api_instance->getActiveProcesses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingApi->getActiveProcesses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingApi->new();

eval { 
    my $result = $api_instance->getActiveProcesses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingApi->getActiveProcesses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingApi()

try: 
    # Get Active Processes
    api_response = api_instance.get_active_processes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingApi->getActiveProcesses: %s\n" % e)
extern crate TranscodingApi;

pub fn main() {

    let mut context = TranscodingApi::Context::default();
    let result = client.getActiveProcesses(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getTranscodeProgress

Get Transcode Progress

TODO


/api/v2/video/transcode/progress

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/transcode/progress"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingApi;

import java.io.File;
import java.util.*;

public class TranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getTranscodeProgress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#getTranscodeProgress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingApi;

public class TranscodingApiExample {
    public static void main(String[] args) {
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getTranscodeProgress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#getTranscodeProgress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
TranscodingApi *apiInstance = [[TranscodingApi alloc] init];

// Get Transcode Progress
[apiInstance getTranscodeProgressWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.TranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTranscodeProgress(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTranscodeProgressExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TranscodingApi();

            try {
                // Get Transcode Progress
                oas_any_type_not_mapped result = apiInstance.getTranscodeProgress();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingApi.getTranscodeProgress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingApi();

try {
    $result = $api_instance->getTranscodeProgress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingApi->getTranscodeProgress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingApi->new();

eval { 
    my $result = $api_instance->getTranscodeProgress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingApi->getTranscodeProgress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingApi()

try: 
    # Get Transcode Progress
    api_response = api_instance.get_transcode_progress()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingApi->getTranscodeProgress: %s\n" % e)
extern crate TranscodingApi;

pub fn main() {

    let mut context = TranscodingApi::Context::default();
    let result = client.getTranscodeProgress(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


progressSubscribe

Progress Subscribe

TODO


/api/v2/video/transcode/progress/subscribe

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/transcode/progress/subscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingApi;

import java.io.File;
import java.util.*;

public class TranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.progressSubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#progressSubscribe");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingApi;

public class TranscodingApiExample {
    public static void main(String[] args) {
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.progressSubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#progressSubscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
TranscodingApi *apiInstance = [[TranscodingApi alloc] init];

// Progress Subscribe
[apiInstance progressSubscribeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.TranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.progressSubscribe(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class progressSubscribeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TranscodingApi();

            try {
                // Progress Subscribe
                oas_any_type_not_mapped result = apiInstance.progressSubscribe();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingApi.progressSubscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingApi();

try {
    $result = $api_instance->progressSubscribe();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingApi->progressSubscribe: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingApi->new();

eval { 
    my $result = $api_instance->progressSubscribe();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingApi->progressSubscribe: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingApi()

try: 
    # Progress Subscribe
    api_response = api_instance.progress_subscribe()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingApi->progressSubscribe: %s\n" % e)
extern crate TranscodingApi;

pub fn main() {

    let mut context = TranscodingApi::Context::default();
    let result = client.progressSubscribe(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


progressSubscribeCMS

Progress Subscribe

TODO


/api/cms/v3/transcode/subscribe

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/transcode/subscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingApi;

import java.io.File;
import java.util.*;

public class TranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.progressSubscribeCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#progressSubscribeCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingApi;

public class TranscodingApiExample {
    public static void main(String[] args) {
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.progressSubscribeCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#progressSubscribeCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
TranscodingApi *apiInstance = [[TranscodingApi alloc] init];

// Progress Subscribe
[apiInstance progressSubscribeCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.TranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.progressSubscribeCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class progressSubscribeCMSExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TranscodingApi();

            try {
                // Progress Subscribe
                oas_any_type_not_mapped result = apiInstance.progressSubscribeCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingApi.progressSubscribeCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingApi();

try {
    $result = $api_instance->progressSubscribeCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingApi->progressSubscribeCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingApi->new();

eval { 
    my $result = $api_instance->progressSubscribeCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingApi->progressSubscribeCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingApi()

try: 
    # Progress Subscribe
    api_response = api_instance.progress_subscribe_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingApi->progressSubscribeCMS: %s\n" % e)
extern crate TranscodingApi;

pub fn main() {

    let mut context = TranscodingApi::Context::default();
    let result = client.progressSubscribeCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


progressUnsubscribe

Progress Unsubscribe

TODO


/api/v2/video/transcode/progress/unsubscribe

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/transcode/progress/unsubscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingApi;

import java.io.File;
import java.util.*;

public class TranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.progressUnsubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#progressUnsubscribe");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingApi;

public class TranscodingApiExample {
    public static void main(String[] args) {
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.progressUnsubscribe();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#progressUnsubscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
TranscodingApi *apiInstance = [[TranscodingApi alloc] init];

// Progress Unsubscribe
[apiInstance progressUnsubscribeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.TranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.progressUnsubscribe(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class progressUnsubscribeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TranscodingApi();

            try {
                // Progress Unsubscribe
                oas_any_type_not_mapped result = apiInstance.progressUnsubscribe();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingApi.progressUnsubscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingApi();

try {
    $result = $api_instance->progressUnsubscribe();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingApi->progressUnsubscribe: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingApi->new();

eval { 
    my $result = $api_instance->progressUnsubscribe();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingApi->progressUnsubscribe: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingApi()

try: 
    # Progress Unsubscribe
    api_response = api_instance.progress_unsubscribe()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingApi->progressUnsubscribe: %s\n" % e)
extern crate TranscodingApi;

pub fn main() {

    let mut context = TranscodingApi::Context::default();
    let result = client.progressUnsubscribe(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


progressUnsubscribeCMS

Progress Unsubscribe

TODO


/api/cms/v3/transcode/unsubscribe

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/cms/v3/transcode/unsubscribe"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TranscodingApi;

import java.io.File;
import java.util.*;

public class TranscodingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.progressUnsubscribeCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#progressUnsubscribeCMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TranscodingApi;

public class TranscodingApiExample {
    public static void main(String[] args) {
        TranscodingApi apiInstance = new TranscodingApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.progressUnsubscribeCMS();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscodingApi#progressUnsubscribeCMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
TranscodingApi *apiInstance = [[TranscodingApi alloc] init];

// Progress Unsubscribe
[apiInstance progressUnsubscribeCMSWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.TranscodingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.progressUnsubscribeCMS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class progressUnsubscribeCMSExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TranscodingApi();

            try {
                // Progress Unsubscribe
                oas_any_type_not_mapped result = apiInstance.progressUnsubscribeCMS();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TranscodingApi.progressUnsubscribeCMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TranscodingApi();

try {
    $result = $api_instance->progressUnsubscribeCMS();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscodingApi->progressUnsubscribeCMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TranscodingApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TranscodingApi->new();

eval { 
    my $result = $api_instance->progressUnsubscribeCMS();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TranscodingApi->progressUnsubscribeCMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TranscodingApi()

try: 
    # Progress Unsubscribe
    api_response = api_instance.progress_unsubscribe_cms()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TranscodingApi->progressUnsubscribeCMS: %s\n" % e)
extern crate TranscodingApi;

pub fn main() {

    let mut context = TranscodingApi::Context::default();
    let result = client.progressUnsubscribeCMS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


User

activateBackupCode

Activate Backup Code

TODO


/api/v2/user/security/backupcode/activate

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/security/backupcode/activate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.activateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#activateBackupCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.activateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#activateBackupCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Activate Backup Code
[apiInstance activateBackupCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.activateBackupCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class activateBackupCodeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Activate Backup Code
                oas_any_type_not_mapped result = apiInstance.activateBackupCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.activateBackupCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->activateBackupCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->activateBackupCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->activateBackupCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->activateBackupCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Activate Backup Code
    api_response = api_instance.activate_backup_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->activateBackupCode: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.activateBackupCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


activateTwoFactorAuthentication

Activate Two Factor Authentication

TODO


/api/v2/user/security/2fa/activate

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/security/2fa/activate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.activateTwoFactorAuthentication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#activateTwoFactorAuthentication");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.activateTwoFactorAuthentication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#activateTwoFactorAuthentication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Activate Two Factor Authentication
[apiInstance activateTwoFactorAuthenticationWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.activateTwoFactorAuthentication(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class activateTwoFactorAuthenticationExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Activate Two Factor Authentication
                oas_any_type_not_mapped result = apiInstance.activateTwoFactorAuthentication();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.activateTwoFactorAuthentication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->activateTwoFactorAuthentication();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->activateTwoFactorAuthentication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->activateTwoFactorAuthentication();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->activateTwoFactorAuthentication: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Activate Two Factor Authentication
    api_response = api_instance.activate_two_factor_authentication()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->activateTwoFactorAuthentication: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.activateTwoFactorAuthentication(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


changePassword

Change Password

TODO


/api/v2/user/password/change

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/password/change"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.changePassword();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#changePassword");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.changePassword();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#changePassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Change Password
[apiInstance changePasswordWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.changePassword(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class changePasswordExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Change Password
                oas_any_type_not_mapped result = apiInstance.changePassword();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.changePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->changePassword();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->changePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->changePassword();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->changePassword: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Change Password
    api_response = api_instance.change_password()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->changePassword: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.changePassword(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


completeEmailChange

Complete Email Change

TODO


/api/v2/user/email/update/complete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/email/update/complete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.completeEmailChange();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#completeEmailChange");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.completeEmailChange();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#completeEmailChange");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Complete Email Change
[apiInstance completeEmailChangeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.completeEmailChange(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class completeEmailChangeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Complete Email Change
                oas_any_type_not_mapped result = apiInstance.completeEmailChange();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.completeEmailChange: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->completeEmailChange();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->completeEmailChange: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->completeEmailChange();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->completeEmailChange: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Complete Email Change
    api_response = api_instance.complete_email_change()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->completeEmailChange: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.completeEmailChange(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


deactivateBackupCode

Deactivate Backup Code

TODO


/api/v2/user/security/backupcode/deactivate

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/security/backupcode/deactivate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deactivateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deactivateBackupCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deactivateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deactivateBackupCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Deactivate Backup Code
[apiInstance deactivateBackupCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deactivateBackupCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deactivateBackupCodeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Deactivate Backup Code
                oas_any_type_not_mapped result = apiInstance.deactivateBackupCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.deactivateBackupCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->deactivateBackupCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deactivateBackupCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->deactivateBackupCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->deactivateBackupCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Deactivate Backup Code
    api_response = api_instance.deactivate_backup_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->deactivateBackupCode: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.deactivateBackupCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


deactivateTwoFactorAuthentication

Deactivate Two Factor Authentication

TODO


/api/v2/user/security/2fa/deactivate

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/security/2fa/deactivate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deactivateTwoFactorAuthentication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deactivateTwoFactorAuthentication");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.deactivateTwoFactorAuthentication();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deactivateTwoFactorAuthentication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Deactivate Two Factor Authentication
[apiInstance deactivateTwoFactorAuthenticationWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deactivateTwoFactorAuthentication(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deactivateTwoFactorAuthenticationExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Deactivate Two Factor Authentication
                oas_any_type_not_mapped result = apiInstance.deactivateTwoFactorAuthentication();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.deactivateTwoFactorAuthentication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->deactivateTwoFactorAuthentication();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deactivateTwoFactorAuthentication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->deactivateTwoFactorAuthentication();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->deactivateTwoFactorAuthentication: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Deactivate Two Factor Authentication
    api_response = api_instance.deactivate_two_factor_authentication()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->deactivateTwoFactorAuthentication: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.deactivateTwoFactorAuthentication(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


generateBackupCode

Generate Backup Code

TODO


/api/v2/user/security/backupcode

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/security/backupcode"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.generateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#generateBackupCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.generateBackupCode();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#generateBackupCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Generate Backup Code
[apiInstance generateBackupCodeWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateBackupCode(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class generateBackupCodeExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Generate Backup Code
                oas_any_type_not_mapped result = apiInstance.generateBackupCode();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.generateBackupCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->generateBackupCode();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->generateBackupCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->generateBackupCode();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->generateBackupCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Generate Backup Code
    api_response = api_instance.generate_backup_code()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->generateBackupCode: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.generateBackupCode(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


generateTwoFactorSecret

Generate Two Factor Secret

TODO


/api/v2/user/security/2fa

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/security/2fa"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.generateTwoFactorSecret();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#generateTwoFactorSecret");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.generateTwoFactorSecret();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#generateTwoFactorSecret");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Generate Two Factor Secret
[apiInstance generateTwoFactorSecretWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateTwoFactorSecret(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class generateTwoFactorSecretExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Generate Two Factor Secret
                oas_any_type_not_mapped result = apiInstance.generateTwoFactorSecret();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.generateTwoFactorSecret: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->generateTwoFactorSecret();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->generateTwoFactorSecret: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->generateTwoFactorSecret();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->generateTwoFactorSecret: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Generate Two Factor Secret
    api_response = api_instance.generate_two_factor_secret()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->generateTwoFactorSecret: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.generateTwoFactorSecret(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getAchievementPerks

Get Achievement Perks

TODO


/api/v3/user/achievement/perks

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/achievement/perks"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAchievementPerks();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getAchievementPerks");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAchievementPerks();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getAchievementPerks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get Achievement Perks
[apiInstance getAchievementPerksWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAchievementPerks(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAchievementPerksExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get Achievement Perks
                oas_any_type_not_mapped result = apiInstance.getAchievementPerks();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getAchievementPerks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->getAchievementPerks();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getAchievementPerks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->getAchievementPerks();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getAchievementPerks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Get Achievement Perks
    api_response = api_instance.get_achievement_perks()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getAchievementPerks: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.getAchievementPerks(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getActivityFeedV2

Get Activity Feed

TODO


/api/v2/user/activity

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/activity"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getActivityFeedV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getActivityFeedV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getActivityFeedV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getActivityFeedV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get Activity Feed
[apiInstance getActivityFeedV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActivityFeedV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getActivityFeedV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get Activity Feed
                oas_any_type_not_mapped result = apiInstance.getActivityFeedV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getActivityFeedV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->getActivityFeedV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getActivityFeedV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->getActivityFeedV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getActivityFeedV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Get Activity Feed
    api_response = api_instance.get_activity_feed_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getActivityFeedV2: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.getActivityFeedV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getActivityFeedV3

Get Activity Feed

Retrieve recent activity for a user, such as comments and other interactions they have made on posts for creators.


/api/v3/user/activity

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/activity?id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String id = id_example; // String | The GUID of the user being queried.
        
        try {
            UserActivityV3Response result = apiInstance.getActivityFeedV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getActivityFeedV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String id = id_example; // String | The GUID of the user being queried.
        
        try {
            UserActivityV3Response result = apiInstance.getActivityFeedV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getActivityFeedV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *id = id_example; // The GUID of the user being queried. (default to null)

// Get Activity Feed
[apiInstance getActivityFeedV3With:id
              completionHandler: ^(UserActivityV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var id = id_example; // {String} The GUID of the user being queried.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActivityFeedV3(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getActivityFeedV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();
            var id = id_example;  // String | The GUID of the user being queried. (default to null)

            try {
                // Get Activity Feed
                UserActivityV3Response result = apiInstance.getActivityFeedV3(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getActivityFeedV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$id = id_example; // String | The GUID of the user being queried.

try {
    $result = $api_instance->getActivityFeedV3($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getActivityFeedV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $id = id_example; # String | The GUID of the user being queried.

eval { 
    my $result = $api_instance->getActivityFeedV3(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getActivityFeedV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
id = id_example # String | The GUID of the user being queried. (default to null)

try: 
    # Get Activity Feed
    api_response = api_instance.get_activity_feed_v3(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getActivityFeedV3: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let id = id_example; // String

    let mut context = UserApi::Context::default();
    let result = client.getActivityFeedV3(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the user being queried.
Required

Responses


getAdministrator

Get Administrator

TODO


/api/v2/user/administrator

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/administrator"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAdministrator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getAdministrator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAdministrator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getAdministrator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get Administrator
[apiInstance getAdministratorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAdministrator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAdministratorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get Administrator
                oas_any_type_not_mapped result = apiInstance.getAdministrator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getAdministrator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->getAdministrator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getAdministrator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->getAdministrator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getAdministrator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Get Administrator
    api_response = api_instance.get_administrator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getAdministrator: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.getAdministrator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getExternalLinksV2

Get External Links

TODO


/api/v2/user/links

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/links"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getExternalLinksV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getExternalLinksV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getExternalLinksV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getExternalLinksV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get External Links
[apiInstance getExternalLinksV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExternalLinksV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getExternalLinksV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get External Links
                oas_any_type_not_mapped result = apiInstance.getExternalLinksV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getExternalLinksV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->getExternalLinksV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getExternalLinksV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->getExternalLinksV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getExternalLinksV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Get External Links
    api_response = api_instance.get_external_links_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getExternalLinksV2: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.getExternalLinksV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getExternalLinksV3

Get External Links

Retrieve configured social media links from a user's profile.


/api/v3/user/links

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/links?id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String id = id_example; // String | The GUID of the user being searched.
        
        try {
            map['String', Object] result = apiInstance.getExternalLinksV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getExternalLinksV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String id = id_example; // String | The GUID of the user being searched.
        
        try {
            map['String', Object] result = apiInstance.getExternalLinksV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getExternalLinksV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *id = id_example; // The GUID of the user being searched. (default to null)

// Get External Links
[apiInstance getExternalLinksV3With:id
              completionHandler: ^(map['String', Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var id = id_example; // {String} The GUID of the user being searched.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExternalLinksV3(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getExternalLinksV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();
            var id = id_example;  // String | The GUID of the user being searched. (default to null)

            try {
                // Get External Links
                map['String', Object] result = apiInstance.getExternalLinksV3(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getExternalLinksV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$id = id_example; // String | The GUID of the user being searched.

try {
    $result = $api_instance->getExternalLinksV3($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getExternalLinksV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $id = id_example; # String | The GUID of the user being searched.

eval { 
    my $result = $api_instance->getExternalLinksV3(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getExternalLinksV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
id = id_example # String | The GUID of the user being searched. (default to null)

try: 
    # Get External Links
    api_response = api_instance.get_external_links_v3(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getExternalLinksV3: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let id = id_example; // String

    let mut context = UserApi::Context::default();
    let result = client.getExternalLinksV3(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the user being searched.
Required

Responses


getSecurity

Get Security

Retrieve information about the current security configuration for the user.


/api/v2/user/security

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/security"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            UserSecurityV2Response result = apiInstance.getSecurity();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getSecurity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            UserSecurityV2Response result = apiInstance.getSecurity();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getSecurity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get Security
[apiInstance getSecurityWithCompletionHandler: 
              ^(UserSecurityV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSecurity(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSecurityExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get Security
                UserSecurityV2Response result = apiInstance.getSecurity();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getSecurity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->getSecurity();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getSecurity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->getSecurity();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getSecurity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Get Security
    api_response = api_instance.get_security()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getSecurity: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.getSecurity(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getSelf

Get Self

Retrieve more detailed information about the user, including their name and email.


/api/v3/user/self

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/self"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            UserSelfV3Response result = apiInstance.getSelf();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getSelf");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            UserSelfV3Response result = apiInstance.getSelf();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getSelf");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get Self
[apiInstance getSelfWithCompletionHandler: 
              ^(UserSelfV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSelf(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSelfExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get Self
                UserSelfV3Response result = apiInstance.getSelf();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getSelf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->getSelf();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getSelf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->getSelf();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getSelf: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Get Self
    api_response = api_instance.get_self()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getSelf: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.getSelf(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUserCreator

Get Creator

TODO


/api/v2/user/creator

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/creator"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserCreator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserCreator();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserCreator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get Creator
[apiInstance getUserCreatorWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserCreator(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserCreatorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get Creator
                oas_any_type_not_mapped result = apiInstance.getUserCreator();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getUserCreator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->getUserCreator();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserCreator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->getUserCreator();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUserCreator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Get Creator
    api_response = api_instance.get_user_creator()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUserCreator: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.getUserCreator(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUserInfo

Info

Retrieve more detailed information about one or more users from their identifiers.


/api/v2/user/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/info?id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        array[String] id = ; // array[String] | The GUID identifer(s) of the user(s) to be retrieved.
        
        try {
            UserInfoV2Response result = apiInstance.getUserInfo(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        array[String] id = ; // array[String] | The GUID identifer(s) of the user(s) to be retrieved.
        
        try {
            UserInfoV2Response result = apiInstance.getUserInfo(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
array[String] *id = ; // The GUID identifer(s) of the user(s) to be retrieved. (default to null)

// Info
[apiInstance getUserInfoWith:id
              completionHandler: ^(UserInfoV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var id = ; // {array[String]} The GUID identifer(s) of the user(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserInfo(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();
            var id = new array[String](); // array[String] | The GUID identifer(s) of the user(s) to be retrieved. (default to null)

            try {
                // Info
                UserInfoV2Response result = apiInstance.getUserInfo(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getUserInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$id = ; // array[String] | The GUID identifer(s) of the user(s) to be retrieved.

try {
    $result = $api_instance->getUserInfo($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $id = []; # array[String] | The GUID identifer(s) of the user(s) to be retrieved.

eval { 
    my $result = $api_instance->getUserInfo(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUserInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
id =  # array[String] | The GUID identifer(s) of the user(s) to be retrieved. (default to null)

try: 
    # Info
    api_response = api_instance.get_user_info(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUserInfo: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let id = ; // array[String]

    let mut context = UserApi::Context::default();
    let result = client.getUserInfo(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
array[String]
The GUID identifer(s) of the user(s) to be retrieved.
Required

Responses


getUserInfoByName

Get Info By Name

Retrieve more detailed information about one or more users from their usernames.


/api/v2/user/named

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/named?username="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        array[String] username = ; // array[String] | The username(s) of the user(s) to be retrieved.
        
        try {
            UserNamedV2Response result = apiInstance.getUserInfoByName(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserInfoByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        array[String] username = ; // array[String] | The username(s) of the user(s) to be retrieved.
        
        try {
            UserNamedV2Response result = apiInstance.getUserInfoByName(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserInfoByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
array[String] *username = ; // The username(s) of the user(s) to be retrieved. (default to null)

// Get Info By Name
[apiInstance getUserInfoByNameWith:username
              completionHandler: ^(UserNamedV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var username = ; // {array[String]} The username(s) of the user(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserInfoByName(username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserInfoByNameExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();
            var username = new array[String](); // array[String] | The username(s) of the user(s) to be retrieved. (default to null)

            try {
                // Get Info By Name
                UserNamedV2Response result = apiInstance.getUserInfoByName(username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getUserInfoByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$username = ; // array[String] | The username(s) of the user(s) to be retrieved.

try {
    $result = $api_instance->getUserInfoByName($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserInfoByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $username = []; # array[String] | The username(s) of the user(s) to be retrieved.

eval { 
    my $result = $api_instance->getUserInfoByName(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUserInfoByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
username =  # array[String] | The username(s) of the user(s) to be retrieved. (default to null)

try: 
    # Get Info By Name
    api_response = api_instance.get_user_info_by_name(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUserInfoByName: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let username = ; // array[String]

    let mut context = UserApi::Context::default();
    let result = client.getUserInfoByName(username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
username*
array[String]
The username(s) of the user(s) to be retrieved.
Required

Responses


getUserNotificationSettingsV2

Get User Notification Settings

TODO


/api/v2/user/notificationsetting

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/notificationsetting"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserNotificationSettingsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserNotificationSettingsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUserNotificationSettingsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserNotificationSettingsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get User Notification Settings
[apiInstance getUserNotificationSettingsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserNotificationSettingsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserNotificationSettingsV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get User Notification Settings
                oas_any_type_not_mapped result = apiInstance.getUserNotificationSettingsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getUserNotificationSettingsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->getUserNotificationSettingsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserNotificationSettingsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->getUserNotificationSettingsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUserNotificationSettingsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Get User Notification Settings
    api_response = api_instance.get_user_notification_settings_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUserNotificationSettingsV2: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.getUserNotificationSettingsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUserNotificationSettingsV3

Get User Notification Settings

Retrieve notification details for a user. The details are split into seperate settings for each subscribed creator.


/api/v3/user/notification/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/notification/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            array[UserNotificationModel] result = apiInstance.getUserNotificationSettingsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            array[UserNotificationModel] result = apiInstance.getUserNotificationSettingsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Get User Notification Settings
[apiInstance getUserNotificationSettingsV3WithCompletionHandler: 
              ^(array[UserNotificationModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserNotificationSettingsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserNotificationSettingsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Get User Notification Settings
                array[UserNotificationModel] result = apiInstance.getUserNotificationSettingsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getUserNotificationSettingsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->getUserNotificationSettingsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserNotificationSettingsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->getUserNotificationSettingsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUserNotificationSettingsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Get User Notification Settings
    api_response = api_instance.get_user_notification_settings_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUserNotificationSettingsV3: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.getUserNotificationSettingsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


scheduleDeletion

Schedule Deletion

TODO


/api/v3/user/delete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/delete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.scheduleDeletion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#scheduleDeletion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.scheduleDeletion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#scheduleDeletion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Schedule Deletion
[apiInstance scheduleDeletionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.scheduleDeletion(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class scheduleDeletionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Schedule Deletion
                oas_any_type_not_mapped result = apiInstance.scheduleDeletion();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.scheduleDeletion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->scheduleDeletion();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->scheduleDeletion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->scheduleDeletion();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->scheduleDeletion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Schedule Deletion
    api_response = api_instance.schedule_deletion()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->scheduleDeletion: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.scheduleDeletion(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


self

Self

TODO


/api/v2/user/self

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/self"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.self();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#self");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.self();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#self");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Self
[apiInstance selfWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.self(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class selfExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Self
                oas_any_type_not_mapped result = apiInstance.self();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.self: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->self();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->self: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->self();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->self: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Self
    api_response = api_instance.self()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->self: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.self(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


unscheduleDeletion

Unschedule Deletion

TODO


/api/v3/user/undelete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/undelete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unscheduleDeletion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#unscheduleDeletion");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unscheduleDeletion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#unscheduleDeletion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Unschedule Deletion
[apiInstance unscheduleDeletionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unscheduleDeletion(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unscheduleDeletionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Unschedule Deletion
                oas_any_type_not_mapped result = apiInstance.unscheduleDeletion();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.unscheduleDeletion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->unscheduleDeletion();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->unscheduleDeletion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->unscheduleDeletion();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->unscheduleDeletion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Unschedule Deletion
    api_response = api_instance.unschedule_deletion()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->unscheduleDeletion: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.unscheduleDeletion(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateEmail

Update Email

TODO


/api/v2/user/email/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/email/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateEmail");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateEmail();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateEmail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Update Email
[apiInstance updateEmailWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateEmail(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateEmailExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Update Email
                oas_any_type_not_mapped result = apiInstance.updateEmail();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.updateEmail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->updateEmail();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateEmail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->updateEmail();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->updateEmail: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Update Email
    api_response = api_instance.update_email()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->updateEmail: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.updateEmail(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateExternalLinksV2

Update External Links

TODO


/api/v2/user/links

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/links"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateExternalLinksV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateExternalLinksV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateExternalLinksV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateExternalLinksV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Update External Links
[apiInstance updateExternalLinksV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateExternalLinksV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateExternalLinksV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Update External Links
                oas_any_type_not_mapped result = apiInstance.updateExternalLinksV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.updateExternalLinksV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->updateExternalLinksV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateExternalLinksV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->updateExternalLinksV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->updateExternalLinksV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Update External Links
    api_response = api_instance.update_external_links_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->updateExternalLinksV2: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.updateExternalLinksV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateExternalLinksV3

Update External Links

TODO


/api/v3/user/links

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/user/links"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateExternalLinksV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateExternalLinksV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateExternalLinksV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateExternalLinksV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Update External Links
[apiInstance updateExternalLinksV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateExternalLinksV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateExternalLinksV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Update External Links
                oas_any_type_not_mapped result = apiInstance.updateExternalLinksV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.updateExternalLinksV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->updateExternalLinksV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateExternalLinksV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->updateExternalLinksV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->updateExternalLinksV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Update External Links
    api_response = api_instance.update_external_links_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->updateExternalLinksV3: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.updateExternalLinksV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateInfo

Update Info

TODO


/api/v2/user/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Update Info
[apiInstance updateInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Update Info
                oas_any_type_not_mapped result = apiInstance.updateInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.updateInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->updateInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->updateInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->updateInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Update Info
    api_response = api_instance.update_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->updateInfo: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.updateInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateUserNotificationSettingsV2

Update User Notification Settings

TODO


/api/v2/user/notificationsetting

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/notificationsetting"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateUserNotificationSettingsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUserNotificationSettingsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateUserNotificationSettingsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUserNotificationSettingsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Update User Notification Settings
[apiInstance updateUserNotificationSettingsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserNotificationSettingsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserNotificationSettingsV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Update User Notification Settings
                oas_any_type_not_mapped result = apiInstance.updateUserNotificationSettingsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.updateUserNotificationSettingsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->updateUserNotificationSettingsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUserNotificationSettingsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->updateUserNotificationSettingsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->updateUserNotificationSettingsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Update User Notification Settings
    api_response = api_instance.update_user_notification_settings_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->updateUserNotificationSettingsV2: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.updateUserNotificationSettingsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateUserNotificationSettingsV3

Update User Notification Settings

Enable or disable email or push notifications for a specific creator.


/api/v3/user/notification/update

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://www.floatplane.com/api/v3/user/notification/update"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        UserNotificationUpdateV3PostRequest userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest | 
        
        try {
            'Boolean' result = apiInstance.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        UserNotificationUpdateV3PostRequest userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest | 
        
        try {
            'Boolean' result = apiInstance.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
UserNotificationUpdateV3PostRequest *userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // 

// Update User Notification Settings
[apiInstance updateUserNotificationSettingsV3With:userNotificationUpdateV3PostRequest
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // {UserNotificationUpdateV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserNotificationSettingsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userNotificationUpdateV3PostRequest = new UserNotificationUpdateV3PostRequest(); // UserNotificationUpdateV3PostRequest | 

            try {
                // Update User Notification Settings
                'Boolean' result = apiInstance.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.updateUserNotificationSettingsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest | 

try {
    $result = $api_instance->updateUserNotificationSettingsV3($userNotificationUpdateV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUserNotificationSettingsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userNotificationUpdateV3PostRequest = WWW::OPenAPIClient::Object::UserNotificationUpdateV3PostRequest->new(); # UserNotificationUpdateV3PostRequest | 

eval { 
    my $result = $api_instance->updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest => $userNotificationUpdateV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->updateUserNotificationSettingsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false} # UserNotificationUpdateV3PostRequest | 

try: 
    # Update User Notification Settings
    api_response = api_instance.update_user_notification_settings_v3(userNotificationUpdateV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->updateUserNotificationSettingsV3: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest

    let mut context = UserApi::Context::default();
    let result = client.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userNotificationUpdateV3PostRequest *

Responses


uploadAvatar

Upload Avatar

TODO


/api/v2/user/avatar

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/avatar"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadAvatar();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#uploadAvatar");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadAvatar();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#uploadAvatar");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

// Upload Avatar
[apiInstance uploadAvatarWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadAvatar(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadAvatarExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                // Upload Avatar
                oas_any_type_not_mapped result = apiInstance.uploadAvatar();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.uploadAvatar: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->uploadAvatar();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->uploadAvatar: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval { 
    my $result = $api_instance->uploadAvatar();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->uploadAvatar: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try: 
    # Upload Avatar
    api_response = api_instance.upload_avatar()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->uploadAvatar: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.uploadAvatar(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


userCreatorBanStatus

User Creator Ban Status

Determine whether or not the user is banned for a given creator.


/api/v2/user/ban/status

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/user/ban/status?creator="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String creator = creator_example; // String | The GUID of the creator being queried.
        
        try {
            'Boolean' result = apiInstance.userCreatorBanStatus(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userCreatorBanStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String creator = creator_example; // String | The GUID of the creator being queried.
        
        try {
            'Boolean' result = apiInstance.userCreatorBanStatus(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userCreatorBanStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *creator = creator_example; // The GUID of the creator being queried. (default to null)

// User Creator Ban Status
[apiInstance userCreatorBanStatusWith:creator
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.UserApi()
var creator = creator_example; // {String} The GUID of the creator being queried.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userCreatorBanStatus(creator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userCreatorBanStatusExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new UserApi();
            var creator = creator_example;  // String | The GUID of the creator being queried. (default to null)

            try {
                // User Creator Ban Status
                'Boolean' result = apiInstance.userCreatorBanStatus(creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.userCreatorBanStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$creator = creator_example; // String | The GUID of the creator being queried.

try {
    $result = $api_instance->userCreatorBanStatus($creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userCreatorBanStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $creator = creator_example; # String | The GUID of the creator being queried.

eval { 
    my $result = $api_instance->userCreatorBanStatus(creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->userCreatorBanStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
creator = creator_example # String | The GUID of the creator being queried. (default to null)

try: 
    # User Creator Ban Status
    api_response = api_instance.user_creator_ban_status(creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userCreatorBanStatus: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let creator = creator_example; // String

    let mut context = UserApi::Context::default();
    let result = client.userCreatorBanStatus(creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creator*
String
The GUID of the creator being queried.
Required

Responses


Video

getDashClearKeys

Get Dash Clear Keys

TODO


/api/v2/video/dash/watchkey

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/dash/watchkey"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoApi;

import java.io.File;
import java.util.*;

public class VideoApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoApi apiInstance = new VideoApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getDashClearKeys();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoApi#getDashClearKeys");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoApi;

public class VideoApiExample {
    public static void main(String[] args) {
        VideoApi apiInstance = new VideoApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getDashClearKeys();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoApi#getDashClearKeys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoApi *apiInstance = [[VideoApi alloc] init];

// Get Dash Clear Keys
[apiInstance getDashClearKeysWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashClearKeys(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDashClearKeysExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoApi();

            try {
                // Get Dash Clear Keys
                oas_any_type_not_mapped result = apiInstance.getDashClearKeys();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoApi.getDashClearKeys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoApi();

try {
    $result = $api_instance->getDashClearKeys();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoApi->getDashClearKeys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoApi->new();

eval { 
    my $result = $api_instance->getDashClearKeys();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoApi->getDashClearKeys: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoApi()

try: 
    # Get Dash Clear Keys
    api_response = api_instance.get_dash_clear_keys()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoApi->getDashClearKeys: %s\n" % e)
extern crate VideoApi;

pub fn main() {

    let mut context = VideoApi::Context::default();
    let result = client.getDashClearKeys(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getDashClearKeysOverPost

Get Dash Clear Keys Over Post

TODO


/api/v2/video/dash/watchkey

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/dash/watchkey"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoApi;

import java.io.File;
import java.util.*;

public class VideoApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoApi apiInstance = new VideoApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getDashClearKeysOverPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoApi#getDashClearKeysOverPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoApi;

public class VideoApiExample {
    public static void main(String[] args) {
        VideoApi apiInstance = new VideoApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getDashClearKeysOverPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoApi#getDashClearKeysOverPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoApi *apiInstance = [[VideoApi alloc] init];

// Get Dash Clear Keys Over Post
[apiInstance getDashClearKeysOverPostWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashClearKeysOverPost(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDashClearKeysOverPostExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoApi();

            try {
                // Get Dash Clear Keys Over Post
                oas_any_type_not_mapped result = apiInstance.getDashClearKeysOverPost();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoApi.getDashClearKeysOverPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoApi();

try {
    $result = $api_instance->getDashClearKeysOverPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoApi->getDashClearKeysOverPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoApi->new();

eval { 
    my $result = $api_instance->getDashClearKeysOverPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoApi->getDashClearKeysOverPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoApi()

try: 
    # Get Dash Clear Keys Over Post
    api_response = api_instance.get_dash_clear_keys_over_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoApi->getDashClearKeysOverPost: %s\n" % e)
extern crate VideoApi;

pub fn main() {

    let mut context = VideoApi::Context::default();
    let result = client.getDashClearKeysOverPost(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getDashSignedChunkUrl

Get Dash Signed Chunk Url

TODO


/api/v2/video/dash/chunk/signed

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/dash/chunk/signed"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoApi;

import java.io.File;
import java.util.*;

public class VideoApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoApi apiInstance = new VideoApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getDashSignedChunkUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoApi#getDashSignedChunkUrl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoApi;

public class VideoApiExample {
    public static void main(String[] args) {
        VideoApi apiInstance = new VideoApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getDashSignedChunkUrl();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoApi#getDashSignedChunkUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoApi *apiInstance = [[VideoApi alloc] init];

// Get Dash Signed Chunk Url
[apiInstance getDashSignedChunkUrlWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashSignedChunkUrl(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDashSignedChunkUrlExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoApi();

            try {
                // Get Dash Signed Chunk Url
                oas_any_type_not_mapped result = apiInstance.getDashSignedChunkUrl();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoApi.getDashSignedChunkUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoApi();

try {
    $result = $api_instance->getDashSignedChunkUrl();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoApi->getDashSignedChunkUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoApi->new();

eval { 
    my $result = $api_instance->getDashSignedChunkUrl();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoApi->getDashSignedChunkUrl: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoApi()

try: 
    # Get Dash Signed Chunk Url
    api_response = api_instance.get_dash_signed_chunk_url()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoApi->getDashSignedChunkUrl: %s\n" % e)
extern crate VideoApi;

pub fn main() {

    let mut context = VideoApi::Context::default();
    let result = client.getDashSignedChunkUrl(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


VideoCommentInteractions

clearInteraction

Clear Interaction

TODO


/api/v2/video/comment/interaction/clear

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/comment/interaction/clear"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentInteractionsApi;

import java.io.File;
import java.util.*;

public class VideoCommentInteractionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoCommentInteractionsApi apiInstance = new VideoCommentInteractionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.clearInteraction();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentInteractionsApi#clearInteraction");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentInteractionsApi;

public class VideoCommentInteractionsApiExample {
    public static void main(String[] args) {
        VideoCommentInteractionsApi apiInstance = new VideoCommentInteractionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.clearInteraction();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentInteractionsApi#clearInteraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoCommentInteractionsApi *apiInstance = [[VideoCommentInteractionsApi alloc] init];

// Clear Interaction
[apiInstance clearInteractionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoCommentInteractionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clearInteraction(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class clearInteractionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoCommentInteractionsApi();

            try {
                // Clear Interaction
                oas_any_type_not_mapped result = apiInstance.clearInteraction();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentInteractionsApi.clearInteraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentInteractionsApi();

try {
    $result = $api_instance->clearInteraction();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentInteractionsApi->clearInteraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentInteractionsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentInteractionsApi->new();

eval { 
    my $result = $api_instance->clearInteraction();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentInteractionsApi->clearInteraction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentInteractionsApi()

try: 
    # Clear Interaction
    api_response = api_instance.clear_interaction()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentInteractionsApi->clearInteraction: %s\n" % e)
extern crate VideoCommentInteractionsApi;

pub fn main() {

    let mut context = VideoCommentInteractionsApi::Context::default();
    let result = client.clearInteraction(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


setInteraction

Set Interaction

TODO


/api/v2/video/comment/interaction/set

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/comment/interaction/set"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentInteractionsApi;

import java.io.File;
import java.util.*;

public class VideoCommentInteractionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoCommentInteractionsApi apiInstance = new VideoCommentInteractionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.setInteraction();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentInteractionsApi#setInteraction");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentInteractionsApi;

public class VideoCommentInteractionsApiExample {
    public static void main(String[] args) {
        VideoCommentInteractionsApi apiInstance = new VideoCommentInteractionsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.setInteraction();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentInteractionsApi#setInteraction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoCommentInteractionsApi *apiInstance = [[VideoCommentInteractionsApi alloc] init];

// Set Interaction
[apiInstance setInteractionWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoCommentInteractionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setInteraction(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class setInteractionExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoCommentInteractionsApi();

            try {
                // Set Interaction
                oas_any_type_not_mapped result = apiInstance.setInteraction();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentInteractionsApi.setInteraction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentInteractionsApi();

try {
    $result = $api_instance->setInteraction();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentInteractionsApi->setInteraction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentInteractionsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentInteractionsApi->new();

eval { 
    my $result = $api_instance->setInteraction();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentInteractionsApi->setInteraction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentInteractionsApi()

try: 
    # Set Interaction
    api_response = api_instance.set_interaction()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentInteractionsApi->setInteraction: %s\n" % e)
extern crate VideoCommentInteractionsApi;

pub fn main() {

    let mut context = VideoCommentInteractionsApi::Context::default();
    let result = client.setInteraction(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


VideoComments

addVideoComment

Add Video Comment

TODO


/api/v2/video/comment

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/comment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentsApi;

import java.io.File;
import java.util.*;

public class VideoCommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoCommentsApi apiInstance = new VideoCommentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addVideoComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsApi#addVideoComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentsApi;

public class VideoCommentsApiExample {
    public static void main(String[] args) {
        VideoCommentsApi apiInstance = new VideoCommentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.addVideoComment();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsApi#addVideoComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoCommentsApi *apiInstance = [[VideoCommentsApi alloc] init];

// Add Video Comment
[apiInstance addVideoCommentWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoCommentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addVideoComment(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addVideoCommentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoCommentsApi();

            try {
                // Add Video Comment
                oas_any_type_not_mapped result = apiInstance.addVideoComment();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentsApi.addVideoComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentsApi();

try {
    $result = $api_instance->addVideoComment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentsApi->addVideoComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentsApi->new();

eval { 
    my $result = $api_instance->addVideoComment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentsApi->addVideoComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentsApi()

try: 
    # Add Video Comment
    api_response = api_instance.add_video_comment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentsApi->addVideoComment: %s\n" % e)
extern crate VideoCommentsApi;

pub fn main() {

    let mut context = VideoCommentsApi::Context::default();
    let result = client.addVideoComment(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getVideoCommentReplies

Get Video Comment Replies

TODO


/api/v2/video/comment/replies

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/comment/replies"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentsApi;

import java.io.File;
import java.util.*;

public class VideoCommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoCommentsApi apiInstance = new VideoCommentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoCommentReplies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsApi#getVideoCommentReplies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentsApi;

public class VideoCommentsApiExample {
    public static void main(String[] args) {
        VideoCommentsApi apiInstance = new VideoCommentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoCommentReplies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsApi#getVideoCommentReplies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoCommentsApi *apiInstance = [[VideoCommentsApi alloc] init];

// Get Video Comment Replies
[apiInstance getVideoCommentRepliesWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoCommentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoCommentReplies(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVideoCommentRepliesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoCommentsApi();

            try {
                // Get Video Comment Replies
                oas_any_type_not_mapped result = apiInstance.getVideoCommentReplies();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentsApi.getVideoCommentReplies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentsApi();

try {
    $result = $api_instance->getVideoCommentReplies();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentsApi->getVideoCommentReplies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentsApi->new();

eval { 
    my $result = $api_instance->getVideoCommentReplies();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentsApi->getVideoCommentReplies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentsApi()

try: 
    # Get Video Comment Replies
    api_response = api_instance.get_video_comment_replies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentsApi->getVideoCommentReplies: %s\n" % e)
extern crate VideoCommentsApi;

pub fn main() {

    let mut context = VideoCommentsApi::Context::default();
    let result = client.getVideoCommentReplies(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getVideoComments

Get Video Comments

TODO


/api/v2/video/comments

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/comments"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoCommentsApi;

import java.io.File;
import java.util.*;

public class VideoCommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoCommentsApi apiInstance = new VideoCommentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoComments();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsApi#getVideoComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoCommentsApi;

public class VideoCommentsApiExample {
    public static void main(String[] args) {
        VideoCommentsApi apiInstance = new VideoCommentsApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getVideoComments();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoCommentsApi#getVideoComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoCommentsApi *apiInstance = [[VideoCommentsApi alloc] init];

// Get Video Comments
[apiInstance getVideoCommentsWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoCommentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoComments(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVideoCommentsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoCommentsApi();

            try {
                // Get Video Comments
                oas_any_type_not_mapped result = apiInstance.getVideoComments();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoCommentsApi.getVideoComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoCommentsApi();

try {
    $result = $api_instance->getVideoComments();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoCommentsApi->getVideoComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoCommentsApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoCommentsApi->new();

eval { 
    my $result = $api_instance->getVideoComments();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoCommentsApi->getVideoComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoCommentsApi()

try: 
    # Get Video Comments
    api_response = api_instance.get_video_comments()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoCommentsApi->getVideoComments: %s\n" % e)
extern crate VideoCommentsApi;

pub fn main() {

    let mut context = VideoCommentsApi::Context::default();
    let result = client.getVideoComments(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


VideoUpload

abortMultipartUploadV2

Abort Multipart Upload

TODO


/api/v2/video/upload/s3/multipart/abort

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart/abort"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadApi;

import java.io.File;
import java.util.*;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#abortMultipartUploadV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadApi;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#abortMultipartUploadV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoUploadApi *apiInstance = [[VideoUploadApi alloc] init];

// Abort Multipart Upload
[apiInstance abortMultipartUploadV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.abortMultipartUploadV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class abortMultipartUploadV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoUploadApi();

            try {
                // Abort Multipart Upload
                oas_any_type_not_mapped result = apiInstance.abortMultipartUploadV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadApi.abortMultipartUploadV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadApi();

try {
    $result = $api_instance->abortMultipartUploadV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadApi->abortMultipartUploadV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadApi->new();

eval { 
    my $result = $api_instance->abortMultipartUploadV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadApi->abortMultipartUploadV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadApi()

try: 
    # Abort Multipart Upload
    api_response = api_instance.abort_multipart_upload_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadApi->abortMultipartUploadV2: %s\n" % e)
extern crate VideoUploadApi;

pub fn main() {

    let mut context = VideoUploadApi::Context::default();
    let result = client.abortMultipartUploadV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


completeMultipartUploadVideo

Complete Multipart Upload

TODO


/api/v2/video/upload/s3/multipart/complete

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart/complete"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadApi;

import java.io.File;
import java.util.*;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.completeMultipartUploadVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#completeMultipartUploadVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadApi;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.completeMultipartUploadVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#completeMultipartUploadVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoUploadApi *apiInstance = [[VideoUploadApi alloc] init];

// Complete Multipart Upload
[apiInstance completeMultipartUploadVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.completeMultipartUploadVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class completeMultipartUploadVideoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoUploadApi();

            try {
                // Complete Multipart Upload
                oas_any_type_not_mapped result = apiInstance.completeMultipartUploadVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadApi.completeMultipartUploadVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadApi();

try {
    $result = $api_instance->completeMultipartUploadVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadApi->completeMultipartUploadVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadApi->new();

eval { 
    my $result = $api_instance->completeMultipartUploadVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadApi->completeMultipartUploadVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadApi()

try: 
    # Complete Multipart Upload
    api_response = api_instance.complete_multipart_upload_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadApi->completeMultipartUploadVideo: %s\n" % e)
extern crate VideoUploadApi;

pub fn main() {

    let mut context = VideoUploadApi::Context::default();
    let result = client.completeMultipartUploadVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


createMultipartUploadV2

Create Multipart Upload

TODO


/api/v2/video/upload/s3/multipart

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadApi;

import java.io.File;
import java.util.*;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createMultipartUploadV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#createMultipartUploadV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadApi;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.createMultipartUploadV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#createMultipartUploadV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoUploadApi *apiInstance = [[VideoUploadApi alloc] init];

// Create Multipart Upload
[apiInstance createMultipartUploadV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMultipartUploadV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createMultipartUploadV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoUploadApi();

            try {
                // Create Multipart Upload
                oas_any_type_not_mapped result = apiInstance.createMultipartUploadV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadApi.createMultipartUploadV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadApi();

try {
    $result = $api_instance->createMultipartUploadV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadApi->createMultipartUploadV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadApi->new();

eval { 
    my $result = $api_instance->createMultipartUploadV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadApi->createMultipartUploadV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadApi()

try: 
    # Create Multipart Upload
    api_response = api_instance.create_multipart_upload_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadApi->createMultipartUploadV2: %s\n" % e)
extern crate VideoUploadApi;

pub fn main() {

    let mut context = VideoUploadApi::Context::default();
    let result = client.createMultipartUploadV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUploadedPartsV2

Get Uploaded Parts

TODO


/api/v2/video/upload/s3/multipart

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadApi;

import java.io.File;
import java.util.*;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUploadedPartsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#getUploadedPartsV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadApi;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getUploadedPartsV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#getUploadedPartsV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoUploadApi *apiInstance = [[VideoUploadApi alloc] init];

// Get Uploaded Parts
[apiInstance getUploadedPartsV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUploadedPartsV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUploadedPartsV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoUploadApi();

            try {
                // Get Uploaded Parts
                oas_any_type_not_mapped result = apiInstance.getUploadedPartsV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadApi.getUploadedPartsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadApi();

try {
    $result = $api_instance->getUploadedPartsV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadApi->getUploadedPartsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadApi->new();

eval { 
    my $result = $api_instance->getUploadedPartsV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadApi->getUploadedPartsV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadApi()

try: 
    # Get Uploaded Parts
    api_response = api_instance.get_uploaded_parts_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadApi->getUploadedPartsV2: %s\n" % e)
extern crate VideoUploadApi;

pub fn main() {

    let mut context = VideoUploadApi::Context::default();
    let result = client.getUploadedPartsV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


signPartUploadVideo

Sign Part Upload

TODO


/api/v2/video/upload/s3/multipart/sign

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/upload/s3/multipart/sign"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadApi;

import java.io.File;
import java.util.*;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.signPartUploadVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#signPartUploadVideo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadApi;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.signPartUploadVideo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#signPartUploadVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoUploadApi *apiInstance = [[VideoUploadApi alloc] init];

// Sign Part Upload
[apiInstance signPartUploadVideoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signPartUploadVideo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class signPartUploadVideoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoUploadApi();

            try {
                // Sign Part Upload
                oas_any_type_not_mapped result = apiInstance.signPartUploadVideo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadApi.signPartUploadVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadApi();

try {
    $result = $api_instance->signPartUploadVideo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadApi->signPartUploadVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadApi->new();

eval { 
    my $result = $api_instance->signPartUploadVideo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadApi->signPartUploadVideo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadApi()

try: 
    # Sign Part Upload
    api_response = api_instance.sign_part_upload_video()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadApi->signPartUploadVideo: %s\n" % e)
extern crate VideoUploadApi;

pub fn main() {

    let mut context = VideoUploadApi::Context::default();
    let result = client.signPartUploadVideo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


uploadThumbnailV2

Upload Thumbnail

TODO


/api/v2/video/upload/thumbnail

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/video/upload/thumbnail"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VideoUploadApi;

import java.io.File;
import java.util.*;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadThumbnailV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#uploadThumbnailV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VideoUploadApi;

public class VideoUploadApiExample {
    public static void main(String[] args) {
        VideoUploadApi apiInstance = new VideoUploadApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.uploadThumbnailV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideoUploadApi#uploadThumbnailV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VideoUploadApi *apiInstance = [[VideoUploadApi alloc] init];

// Upload Thumbnail
[apiInstance uploadThumbnailV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VideoUploadApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadThumbnailV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadThumbnailV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VideoUploadApi();

            try {
                // Upload Thumbnail
                oas_any_type_not_mapped result = apiInstance.uploadThumbnailV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VideoUploadApi.uploadThumbnailV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VideoUploadApi();

try {
    $result = $api_instance->uploadThumbnailV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideoUploadApi->uploadThumbnailV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VideoUploadApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VideoUploadApi->new();

eval { 
    my $result = $api_instance->uploadThumbnailV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideoUploadApi->uploadThumbnailV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VideoUploadApi()

try: 
    # Upload Thumbnail
    api_response = api_instance.upload_thumbnail_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideoUploadApi->uploadThumbnailV2: %s\n" % e)
extern crate VideoUploadApi;

pub fn main() {

    let mut context = VideoUploadApi::Context::default();
    let result = client.uploadThumbnailV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Vpn

downloadUserProfile

Download User Profile

TODO


/api/v3/experiments/vpn/profile/download

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/experiments/vpn/profile/download"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VpnApi;

import java.io.File;
import java.util.*;

public class VpnApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VpnApi apiInstance = new VpnApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.downloadUserProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnApi#downloadUserProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VpnApi;

public class VpnApiExample {
    public static void main(String[] args) {
        VpnApi apiInstance = new VpnApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.downloadUserProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnApi#downloadUserProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VpnApi *apiInstance = [[VpnApi alloc] init];

// Download User Profile
[apiInstance downloadUserProfileWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VpnApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadUserProfile(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class downloadUserProfileExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VpnApi();

            try {
                // Download User Profile
                oas_any_type_not_mapped result = apiInstance.downloadUserProfile();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VpnApi.downloadUserProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VpnApi();

try {
    $result = $api_instance->downloadUserProfile();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VpnApi->downloadUserProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VpnApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VpnApi->new();

eval { 
    my $result = $api_instance->downloadUserProfile();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VpnApi->downloadUserProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VpnApi()

try: 
    # Download User Profile
    api_response = api_instance.download_user_profile()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VpnApi->downloadUserProfile: %s\n" % e)
extern crate VpnApi;

pub fn main() {

    let mut context = VpnApi::Context::default();
    let result = client.downloadUserProfile(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getEnabledState

Get Enabled State

TODO


/api/v3/experiments/vpn/enabled

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/experiments/vpn/enabled"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VpnApi;

import java.io.File;
import java.util.*;

public class VpnApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VpnApi apiInstance = new VpnApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getEnabledState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnApi#getEnabledState");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VpnApi;

public class VpnApiExample {
    public static void main(String[] args) {
        VpnApi apiInstance = new VpnApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getEnabledState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnApi#getEnabledState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VpnApi *apiInstance = [[VpnApi alloc] init];

// Get Enabled State
[apiInstance getEnabledStateWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VpnApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnabledState(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getEnabledStateExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VpnApi();

            try {
                // Get Enabled State
                oas_any_type_not_mapped result = apiInstance.getEnabledState();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VpnApi.getEnabledState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VpnApi();

try {
    $result = $api_instance->getEnabledState();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VpnApi->getEnabledState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VpnApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VpnApi->new();

eval { 
    my $result = $api_instance->getEnabledState();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VpnApi->getEnabledState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VpnApi()

try: 
    # Get Enabled State
    api_response = api_instance.get_enabled_state()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VpnApi->getEnabledState: %s\n" % e)
extern crate VpnApi;

pub fn main() {

    let mut context = VpnApi::Context::default();
    let result = client.getEnabledState(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getServerList

Get Server List

TODO


/api/v3/experiments/vpn/server/list

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/experiments/vpn/server/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VpnApi;

import java.io.File;
import java.util.*;

public class VpnApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VpnApi apiInstance = new VpnApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getServerList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnApi#getServerList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VpnApi;

public class VpnApiExample {
    public static void main(String[] args) {
        VpnApi apiInstance = new VpnApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getServerList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnApi#getServerList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VpnApi *apiInstance = [[VpnApi alloc] init];

// Get Server List
[apiInstance getServerListWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VpnApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getServerList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getServerListExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VpnApi();

            try {
                // Get Server List
                oas_any_type_not_mapped result = apiInstance.getServerList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VpnApi.getServerList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VpnApi();

try {
    $result = $api_instance->getServerList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VpnApi->getServerList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VpnApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VpnApi->new();

eval { 
    my $result = $api_instance->getServerList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VpnApi->getServerList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VpnApi()

try: 
    # Get Server List
    api_response = api_instance.get_server_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VpnApi->getServerList: %s\n" % e)
extern crate VpnApi;

pub fn main() {

    let mut context = VpnApi::Context::default();
    let result = client.getServerList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateEnabledState

Update Enabled State

TODO


/api/v3/experiments/vpn/enabled

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/experiments/vpn/enabled"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VpnApi;

import java.io.File;
import java.util.*;

public class VpnApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        VpnApi apiInstance = new VpnApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateEnabledState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnApi#updateEnabledState");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VpnApi;

public class VpnApiExample {
    public static void main(String[] args) {
        VpnApi apiInstance = new VpnApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.updateEnabledState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VpnApi#updateEnabledState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
VpnApi *apiInstance = [[VpnApi alloc] init];

// Update Enabled State
[apiInstance updateEnabledStateWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.VpnApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateEnabledState(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateEnabledStateExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new VpnApi();

            try {
                // Update Enabled State
                oas_any_type_not_mapped result = apiInstance.updateEnabledState();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VpnApi.updateEnabledState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VpnApi();

try {
    $result = $api_instance->updateEnabledState();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VpnApi->updateEnabledState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VpnApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VpnApi->new();

eval { 
    my $result = $api_instance->updateEnabledState();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VpnApi->updateEnabledState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VpnApi()

try: 
    # Update Enabled State
    api_response = api_instance.update_enabled_state()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VpnApi->updateEnabledState: %s\n" % e)
extern crate VpnApi;

pub fn main() {

    let mut context = VpnApi::Context::default();
    let result = client.updateEnabledState(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


WebNotification

getAppInfoV2

Get App Info

TODO


/api/v2/push/web/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/push/web/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationApi;

import java.io.File;
import java.util.*;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAppInfoV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#getAppInfoV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationApi;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAppInfoV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#getAppInfoV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
WebNotificationApi *apiInstance = [[WebNotificationApi alloc] init];

// Get App Info
[apiInstance getAppInfoV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.WebNotificationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAppInfoV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAppInfoV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new WebNotificationApi();

            try {
                // Get App Info
                oas_any_type_not_mapped result = apiInstance.getAppInfoV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationApi.getAppInfoV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationApi();

try {
    $result = $api_instance->getAppInfoV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationApi->getAppInfoV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationApi->new();

eval { 
    my $result = $api_instance->getAppInfoV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationApi->getAppInfoV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationApi()

try: 
    # Get App Info
    api_response = api_instance.get_app_info_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationApi->getAppInfoV2: %s\n" % e)
extern crate WebNotificationApi;

pub fn main() {

    let mut context = WebNotificationApi::Context::default();
    let result = client.getAppInfoV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getAppInfoV3

Get App Info

TODO


/api/v3/push/web/info

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/push/web/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationApi;

import java.io.File;
import java.util.*;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAppInfoV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#getAppInfoV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationApi;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getAppInfoV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#getAppInfoV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
WebNotificationApi *apiInstance = [[WebNotificationApi alloc] init];

// Get App Info
[apiInstance getAppInfoV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.WebNotificationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAppInfoV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAppInfoV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new WebNotificationApi();

            try {
                // Get App Info
                oas_any_type_not_mapped result = apiInstance.getAppInfoV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationApi.getAppInfoV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationApi();

try {
    $result = $api_instance->getAppInfoV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationApi->getAppInfoV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationApi->new();

eval { 
    my $result = $api_instance->getAppInfoV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationApi->getAppInfoV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationApi()

try: 
    # Get App Info
    api_response = api_instance.get_app_info_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationApi->getAppInfoV3: %s\n" % e)
extern crate WebNotificationApi;

pub fn main() {

    let mut context = WebNotificationApi::Context::default();
    let result = client.getAppInfoV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getTokenInfo

Get Token Info

TODO


/api/v2/push/web/tokenInfo

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/push/web/tokenInfo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationApi;

import java.io.File;
import java.util.*;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getTokenInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#getTokenInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationApi;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.getTokenInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#getTokenInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
WebNotificationApi *apiInstance = [[WebNotificationApi alloc] init];

// Get Token Info
[apiInstance getTokenInfoWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.WebNotificationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTokenInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTokenInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new WebNotificationApi();

            try {
                // Get Token Info
                oas_any_type_not_mapped result = apiInstance.getTokenInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationApi.getTokenInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationApi();

try {
    $result = $api_instance->getTokenInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationApi->getTokenInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationApi->new();

eval { 
    my $result = $api_instance->getTokenInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationApi->getTokenInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationApi()

try: 
    # Get Token Info
    api_response = api_instance.get_token_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationApi->getTokenInfo: %s\n" % e)
extern crate WebNotificationApi;

pub fn main() {

    let mut context = WebNotificationApi::Context::default();
    let result = client.getTokenInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


registerV2

Register

TODO


/api/v2/push/web/register

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/push/web/register"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationApi;

import java.io.File;
import java.util.*;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.registerV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#registerV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationApi;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.registerV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#registerV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
WebNotificationApi *apiInstance = [[WebNotificationApi alloc] init];

// Register
[apiInstance registerV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.WebNotificationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class registerV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new WebNotificationApi();

            try {
                // Register
                oas_any_type_not_mapped result = apiInstance.registerV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationApi.registerV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationApi();

try {
    $result = $api_instance->registerV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationApi->registerV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationApi->new();

eval { 
    my $result = $api_instance->registerV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationApi->registerV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationApi()

try: 
    # Register
    api_response = api_instance.register_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationApi->registerV2: %s\n" % e)
extern crate WebNotificationApi;

pub fn main() {

    let mut context = WebNotificationApi::Context::default();
    let result = client.registerV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


registerV3

Register

TODO


/api/v3/push/web/register

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/push/web/register"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationApi;

import java.io.File;
import java.util.*;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.registerV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#registerV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationApi;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.registerV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#registerV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
WebNotificationApi *apiInstance = [[WebNotificationApi alloc] init];

// Register
[apiInstance registerV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.WebNotificationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class registerV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new WebNotificationApi();

            try {
                // Register
                oas_any_type_not_mapped result = apiInstance.registerV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationApi.registerV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationApi();

try {
    $result = $api_instance->registerV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationApi->registerV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationApi->new();

eval { 
    my $result = $api_instance->registerV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationApi->registerV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationApi()

try: 
    # Register
    api_response = api_instance.register_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationApi->registerV3: %s\n" % e)
extern crate WebNotificationApi;

pub fn main() {

    let mut context = WebNotificationApi::Context::default();
    let result = client.registerV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


unregisterV2

Unregister

TODO


/api/v2/push/web/revoke

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/push/web/revoke"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationApi;

import java.io.File;
import java.util.*;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unregisterV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#unregisterV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationApi;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unregisterV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#unregisterV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
WebNotificationApi *apiInstance = [[WebNotificationApi alloc] init];

// Unregister
[apiInstance unregisterV2WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.WebNotificationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unregisterV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unregisterV2Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new WebNotificationApi();

            try {
                // Unregister
                oas_any_type_not_mapped result = apiInstance.unregisterV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationApi.unregisterV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationApi();

try {
    $result = $api_instance->unregisterV2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationApi->unregisterV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationApi->new();

eval { 
    my $result = $api_instance->unregisterV2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationApi->unregisterV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationApi()

try: 
    # Unregister
    api_response = api_instance.unregister_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationApi->unregisterV2: %s\n" % e)
extern crate WebNotificationApi;

pub fn main() {

    let mut context = WebNotificationApi::Context::default();
    let result = client.unregisterV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


unregisterV3

Unregister

TODO


/api/v3/push/web/revoke

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/push/web/revoke"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebNotificationApi;

import java.io.File;
import java.util.*;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unregisterV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#unregisterV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebNotificationApi;

public class WebNotificationApiExample {
    public static void main(String[] args) {
        WebNotificationApi apiInstance = new WebNotificationApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.unregisterV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebNotificationApi#unregisterV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
WebNotificationApi *apiInstance = [[WebNotificationApi alloc] init];

// Unregister
[apiInstance unregisterV3WithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.WebNotificationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unregisterV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unregisterV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new WebNotificationApi();

            try {
                // Unregister
                oas_any_type_not_mapped result = apiInstance.unregisterV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebNotificationApi.unregisterV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebNotificationApi();

try {
    $result = $api_instance->unregisterV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebNotificationApi->unregisterV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebNotificationApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebNotificationApi->new();

eval { 
    my $result = $api_instance->unregisterV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebNotificationApi->unregisterV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebNotificationApi()

try: 
    # Unregister
    api_response = api_instance.unregister_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebNotificationApi->unregisterV3: %s\n" % e)
extern crate WebNotificationApi;

pub fn main() {

    let mut context = WebNotificationApi::Context::default();
    let result = client.unregisterV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Webhook

connectedAccount

Connected Account

TODO


/api/v2/webhooks/connectedAccount/{site}

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v2/webhooks/connectedAccount/{site}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhookApi;

import java.io.File;
import java.util.*;

public class WebhookApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        WebhookApi apiInstance = new WebhookApi();
        String site = site_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.connectedAccount(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookApi#connectedAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhookApi;

public class WebhookApiExample {
    public static void main(String[] args) {
        WebhookApi apiInstance = new WebhookApi();
        String site = site_example; // String | 
        
        try {
            oas_any_type_not_mapped result = apiInstance.connectedAccount(site);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookApi#connectedAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
WebhookApi *apiInstance = [[WebhookApi alloc] init];
String *site = site_example; //  (default to null)

// Connected Account
[apiInstance connectedAccountWith:site
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.WebhookApi()
var site = site_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.connectedAccount(site, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class connectedAccountExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new WebhookApi();
            var site = site_example;  // String |  (default to null)

            try {
                // Connected Account
                oas_any_type_not_mapped result = apiInstance.connectedAccount(site);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhookApi.connectedAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhookApi();
$site = site_example; // String | 

try {
    $result = $api_instance->connectedAccount($site);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookApi->connectedAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhookApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhookApi->new();
my $site = site_example; # String | 

eval { 
    my $result = $api_instance->connectedAccount(site => $site);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookApi->connectedAccount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhookApi()
site = site_example # String |  (default to null)

try: 
    # Connected Account
    api_response = api_instance.connected_account(site)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookApi->connectedAccount: %s\n" % e)
extern crate WebhookApi;

pub fn main() {
    let site = site_example; // String

    let mut context = WebhookApi::Context::default();
    let result = client.connectedAccount(site, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
site*
String
Required

Responses


livestreamPublish

Livestream Publish

TODO


/api/v3/webhooks/livestream

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://www.floatplane.com/api/v3/webhooks/livestream"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WebhookApi;

import java.io.File;
import java.util.*;

public class WebhookApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        WebhookApi apiInstance = new WebhookApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.livestreamPublish();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookApi#livestreamPublish");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WebhookApi;

public class WebhookApiExample {
    public static void main(String[] args) {
        WebhookApi apiInstance = new WebhookApi();
        
        try {
            oas_any_type_not_mapped result = apiInstance.livestreamPublish();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookApi#livestreamPublish");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
WebhookApi *apiInstance = [[WebhookApi alloc] init];

// Livestream Publish
[apiInstance livestreamPublishWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneApi = require('floatplane_api');
var defaultClient = FloatplaneApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneApi.WebhookApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.livestreamPublish(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class livestreamPublishExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new WebhookApi();

            try {
                // Livestream Publish
                oas_any_type_not_mapped result = apiInstance.livestreamPublish();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling WebhookApi.livestreamPublish: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WebhookApi();

try {
    $result = $api_instance->livestreamPublish();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookApi->livestreamPublish: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WebhookApi;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WebhookApi->new();

eval { 
    my $result = $api_instance->livestreamPublish();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookApi->livestreamPublish: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.WebhookApi()

try: 
    # Livestream Publish
    api_response = api_instance.livestream_publish()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookApi->livestreamPublish: %s\n" % e)
extern crate WebhookApi;

pub fn main() {

    let mut context = WebhookApi::Context::default();
    let result = client.livestreamPublish(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses